https://svacer.ispras.ru/mediawiki/api.php?action=feedcontributions&feedformat=atom&user=GribuninSvacer Wiki - User contributions [en]2026-04-15T08:56:00ZUser contributionsMediaWiki 1.40.1https://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3471Help:CLI/cleanup2026-03-19T13:33:12Z<p>Gribunin: cleanup примеры</p>
<hr />
<div>= Автоматическое удаление снимков =<br />
<br />
== Обзор ==<br />
<br />
Удаление происходит по умолчанию раз в 24 часа (время можно задать при запуске сервера опцией <code>--snapshots-cleanup-period</code>, либо в конфигурационном файле опцией <code>snapshots-cleanup-period</code>, либо переменной окружения <code>SVACER_CLEANUP_SNAPSHOTS_PERIOD</code>, но не меньше 15 минут). Первое удаление всех подходящих снимков будет выполнено через указанное время после запуска сервера.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление самых старых по времени создания подходящих снимков и заносится отметка в таблицу удаленных снимков и в системный журнал. После этого происходит удаление пустых веток и проектов в соответствии с правилами удаления. Также информация об удалении через cleanup вносится в системный журнал.<br />
<br />
Данная функциональность доступна пользователям с доступом '''ServerOperations'''.<br />
<br />
== Добавление нового правила удаления ==<br />
<br />
svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --keep-time <nowiki><time></nowiki> --min-snapshots <min> --cleanup-type <type><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех проектов)<br />
* <code>--branch</code> — ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--keep-time</code> — время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней).<br />
* <code>--min-snapshots</code> — количество снимков, которое необходимо оставлять в ветке, подходящей под паттерн project + branch. По умолчанию 0<br />
* <code>--cleanup-type</code> — тип очистки. Возможные значения - project, branch, snapshot (по умолчанию snapshot). При указании snapshot будут очищаться снимки в соответствии с паттерном проект+ветка+снимок и проверяться <code>keep-time</code> и <code>min-snapshots</code>. При указании branch будут удаляться пустые ветки в соответствии с паттерном project + branch. При указании project Будут удаляться пустые проекты (у которых нет веток) в соответствии с паттерном project. При указании branch или project невозможно указать <code>keep-time</code> и <code>min-snapshots</code>, эти флаги не учитываются.<br />
<br />
=== Шаблоны и паттерны ===<br />
<br />
Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:<br />
<br />
'''1. Имя или ID:'''<br />
--project "MyProject"<br />
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта<br />
<br />
'''2. <code>*</code> (любое количество любых символов):'''<br />
--project "Dev*" # DevProject, Development<br />
--branch "*test*" # test, my-test, testing<br />
--snapshot "nightly-*"<br />
<br />
'''3. Регулярные выражения (с префиксом <code>re:</code>):'''<br />
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5<br />
--branch "re:^feature/[0-9]+$" # feature/123<br />
<br />
== Добавление запрета на удаление ==<br />
<br />
svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех проектов)<br />
<br />
* <code>--branch</code> — ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.<br />
<br />
== Удаление правила ==<br />
<br />
svacer server cleanup delete --user <user> --password <password> --id <config id><br />
<br />
Где:<br />
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)<br />
<br />
== Вывести таблицу ==<br />
<br />
svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json><br />
<br />
Где:<br />
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков<br />
<br />
* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат<br />
== Запуск очистки вручную ==<br />
<br />
svacer server cleanup run --user <user> --password <password><br />
<br />
Запускает процесс очистки немедленно (вне расписания).<br />
<br />
== Примеры ==<br />
<br />
=== Добавление нового правила ===<br />
<br />
'''Удаление по времени'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --keep-time 240h<br />
<br />
Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".<br />
<br />
'''Ограничение количества'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 20 --keep-time 12h<br />
<br />
В любом проекте в ветке "main" всегда будет не более 20 снимков; остальные снимки старше 12 часов будут удаляться.<br />
<br />
'''Очистка пустых веток'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "master" --cleanup-type branch<br />
<br />
В любом проекте, ветка "master" будет удаляться, если в ней нет снимков.<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*"<br />
<br />
Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются правилами cleanup'''.<br />
<br />
=== Вывод таблицы правил ===<br />
<br />
svacer server cleanup list --user admin --password admin --type rule<br />
[[File:Cleanup rules.png|none|thumb|955x955px]]<br />
<br />
=== Вывод таблицы запретов ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule<br />
[[File:Cleanup exclude rule table.png|none|thumb|1009x1009px]]<br />
<br />
=== Вывод в JSON формате ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule --format json<br />
<br />
Вывод:<br />
<br />
[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]<br />
<br />
=== Удаление правила ===<br />
<br />
svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416<br />
<br />
=== Использование regex ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --keep-time 168h<br />
<br />
Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code><br>Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code><br />
<br />
=== Regex синтаксис ===<br />
<br />
{| class="wikitable"<br />
! Паттерн !! Описание !! Пример<br />
|-<br />
| <code>^</code> || Начало строки || <code>^test</code><br />
|-<br />
| <code>[^x]</code> || Отрицание символов || <code>^[^m].*$</code><br />
|-<br />
| <code>$</code> || Конец строки || <code>test$</code><br />
|-<br />
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c<br />
|-<br />
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123<br />
|-<br />
| <code>.+</code> || Один или более || <code>test.+</code> → test-1<br />
|-<br />
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9<br />
|-<br />
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc<br />
|-<br />
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC<br />
|-<br />
| <code>(a&#124;b)</code> || "a" или "b" || <code>(test&#124;prod)</code><br />
|-<br />
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code><br />
|}<br />
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.<br />
<br />
Для правил отрицания конкретного элемента возможно использовать сложные правила, например:<br />
<br />
<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code><br />
<br />
Данное правило выбирает все ветки, кроме <code>main</code>.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3470Help:CLI/cleanup2026-03-19T13:12:35Z<p>Gribunin: cleanup в пример добавлено keep-time</p>
<hr />
<div>= Автоматическое удаление снимков =<br />
<br />
== Обзор ==<br />
<br />
Удаление происходит по умолчанию раз в 24 часа (время можно задать при запуске сервера опцией <code>--snapshots-cleanup-period</code>, либо в конфигурационном файле опцией <code>snapshots-cleanup-period</code>, либо переменной окружения <code>SVACER_CLEANUP_SNAPSHOTS_PERIOD</code>, но не меньше 15 минут). Первое удаление всех подходящих снимков будет выполнено через указанное время после запуска сервера.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление самых старых по времени создания подходящих снимков и заносится отметка в таблицу удаленных снимков и в системный журнал. После этого происходит удаление пустых веток и проектов в соответствии с правилами удаления. Также информация об удалении через cleanup вносится в системный журнал.<br />
<br />
Данная функциональность доступна пользователям с доступом '''ServerOperations'''.<br />
<br />
== Добавление нового правила удаления ==<br />
<br />
svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --keep-time <nowiki><time></nowiki> --min-snapshots <min> --cleanup-type <type><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех проектов)<br />
* <code>--branch</code> — ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--keep-time</code> — время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней).<br />
* <code>--min-snapshots</code> — количество снимков, которое необходимо оставлять в ветке, подходящей под паттерн project + branch. По умолчанию 0<br />
* <code>--cleanup-type</code> — тип очистки. Возможные значения - project, branch, snapshot (по умолчанию snapshot). При указании snapshot будут очищаться снимки в соответствии с паттерном проект+ветка+снимок и проверяться <code>keep-time</code> и <code>min-snapshots</code>. При указании branch будут удаляться пустые ветки в соответствии с паттерном project + branch. При указании project Будут удаляться пустые проекты (у которых нет веток) в соответствии с паттерном project. При указании branch или project невозможно указать <code>keep-time</code> и <code>min-snapshots</code>, эти флаги не учитываются.<br />
<br />
=== Шаблоны и паттерны ===<br />
<br />
Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:<br />
<br />
'''1. Имя или ID:'''<br />
--project "MyProject"<br />
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта<br />
<br />
'''2. <code>*</code> (любое количество любых символов):'''<br />
--project "Dev*" # DevProject, Development<br />
--branch "*test*" # test, my-test, testing<br />
--snapshot "nightly-*"<br />
<br />
'''3. Регулярные выражения (с префиксом <code>re:</code>):'''<br />
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5<br />
--branch "re:^feature/[0-9]+$" # feature/123<br />
<br />
== Добавление запрета на удаление ==<br />
<br />
svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех проектов)<br />
<br />
* <code>--branch</code> — ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.<br />
<br />
== Удаление правила ==<br />
<br />
svacer server cleanup delete --user <user> --password <password> --id <config id><br />
<br />
Где:<br />
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)<br />
<br />
== Вывести таблицу ==<br />
<br />
svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json><br />
<br />
Где:<br />
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков<br />
<br />
* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат<br />
== Запуск очистки вручную ==<br />
<br />
svacer server cleanup run --user <user> --password <password><br />
<br />
Запускает процесс очистки немедленно (вне расписания).<br />
<br />
== Примеры ==<br />
<br />
=== Добавление нового правила ===<br />
<br />
'''Удаление по времени'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --keep-time "240h"<br />
<br />
Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".<br />
<br />
'''Ограничение количества'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 20 --keep-time 0h<br />
<br />
В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.<br />
<br />
'''Очистка пустых веток'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "master" --cleanup-type branch<br />
<br />
В любом проекте, ветка "master" будет удаляться, если в ней нет снимков.<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*"<br />
<br />
Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются правилами cleanup'''.<br />
<br />
=== Вывод таблицы правил ===<br />
<br />
svacer server cleanup list --user admin --password admin --type rule<br />
[[File:Cleanup rules.png|none|thumb|955x955px]]<br />
<br />
=== Вывод таблицы запретов ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule<br />
[[File:Cleanup exclude rule table.png|none|thumb|1009x1009px]]<br />
<br />
=== Вывод в JSON формате ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule --format json<br />
<br />
Вывод:<br />
<br />
[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]<br />
<br />
=== Удаление правила ===<br />
<br />
svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416<br />
<br />
=== Использование regex ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --keep-time 168h<br />
<br />
Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code><br>Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code><br />
<br />
=== Regex синтаксис ===<br />
<br />
{| class="wikitable"<br />
! Паттерн !! Описание !! Пример<br />
|-<br />
| <code>^</code> || Начало строки || <code>^test</code><br />
|-<br />
| <code>[^x]</code> || Отрицание символов || <code>^[^m].*$</code><br />
|-<br />
| <code>$</code> || Конец строки || <code>test$</code><br />
|-<br />
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c<br />
|-<br />
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123<br />
|-<br />
| <code>.+</code> || Один или более || <code>test.+</code> → test-1<br />
|-<br />
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9<br />
|-<br />
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc<br />
|-<br />
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC<br />
|-<br />
| <code>(a&#124;b)</code> || "a" или "b" || <code>(test&#124;prod)</code><br />
|-<br />
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code><br />
|}<br />
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.<br />
<br />
Для правил отрицания конкретного элемента возможно использовать сложные правила, например:<br />
<br />
<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code><br />
<br />
Данное правило выбирает все ветки, кроме <code>main</code>.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3469Help:CLI/cleanup2026-03-19T13:08:24Z<p>Gribunin: cleanup примеры исправление</p>
<hr />
<div>= Автоматическое удаление снимков =<br />
<br />
== Обзор ==<br />
<br />
Удаление происходит по умолчанию раз в 24 часа (время можно задать при запуске сервера опцией <code>--snapshots-cleanup-period</code>, либо в конфигурационном файле опцией <code>snapshots-cleanup-period</code>, либо переменной окружения <code>SVACER_CLEANUP_SNAPSHOTS_PERIOD</code>, но не меньше 15 минут). Первое удаление всех подходящих снимков будет выполнено через указанное время после запуска сервера.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление самых старых по времени создания подходящих снимков и заносится отметка в таблицу удаленных снимков и в системный журнал. После этого происходит удаление пустых веток и проектов в соответствии с правилами удаления. Также информация об удалении через cleanup вносится в системный журнал.<br />
<br />
Данная функциональность доступна пользователям с доступом '''ServerOperations'''.<br />
<br />
== Добавление нового правила удаления ==<br />
<br />
svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --keep-time <nowiki><time></nowiki> --min-snapshots <min> --cleanup-type <type><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех проектов)<br />
* <code>--branch</code> — ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--keep-time</code> — время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней).<br />
* <code>--min-snapshots</code> — количество снимков, которое необходимо оставлять в ветке, подходящей под паттерн project + branch. По умолчанию 0<br />
* <code>--cleanup-type</code> — тип очистки. Возможные значения - project, branch, snapshot (по умолчанию snapshot). При указании snapshot будут очищаться снимки в соответствии с паттерном проект+ветка+снимок и проверяться <code>keep-time</code> и <code>min-snapshots</code>. При указании branch будут удаляться пустые ветки в соответствии с паттерном project + branch. При указании project Будут удаляться пустые проекты (у которых нет веток) в соответствии с паттерном project. При указании branch или project невозможно указать <code>keep-time</code> и <code>min-snapshots</code>, эти флаги не учитываются.<br />
<br />
=== Шаблоны и паттерны ===<br />
<br />
Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:<br />
<br />
'''1. Имя или ID:'''<br />
--project "MyProject"<br />
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта<br />
<br />
'''2. <code>*</code> (любое количество любых символов):'''<br />
--project "Dev*" # DevProject, Development<br />
--branch "*test*" # test, my-test, testing<br />
--snapshot "nightly-*"<br />
<br />
'''3. Регулярные выражения (с префиксом <code>re:</code>):'''<br />
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5<br />
--branch "re:^feature/[0-9]+$" # feature/123<br />
<br />
== Добавление запрета на удаление ==<br />
<br />
svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех проектов)<br />
<br />
* <code>--branch</code> — ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.<br />
<br />
== Удаление правила ==<br />
<br />
svacer server cleanup delete --user <user> --password <password> --id <config id><br />
<br />
Где:<br />
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)<br />
<br />
== Вывести таблицу ==<br />
<br />
svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json><br />
<br />
Где:<br />
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков<br />
<br />
* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат<br />
== Запуск очистки вручную ==<br />
<br />
svacer server cleanup run --user <user> --password <password><br />
<br />
Запускает процесс очистки немедленно (вне расписания).<br />
<br />
== Примеры ==<br />
<br />
=== Добавление нового правила ===<br />
<br />
'''Удаление по времени'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --keep-time "240h"<br />
<br />
Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".<br />
<br />
'''Ограничение количества'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 20<br />
<br />
В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.<br />
<br />
'''Очистка пустых веток'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "master" --cleanup-type branch<br />
<br />
В любом проекте, ветка "master" будет удаляться, если в ней нет снимков.<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*"<br />
<br />
Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются правилами cleanup'''.<br />
<br />
=== Вывод таблицы правил ===<br />
<br />
svacer server cleanup list --user admin --password admin --type rule<br />
[[File:Cleanup rules.png|none|thumb|955x955px]]<br />
<br />
=== Вывод таблицы запретов ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule<br />
[[File:Cleanup exclude rule table.png|none|thumb|1009x1009px]]<br />
<br />
=== Вывод в JSON формате ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule --format json<br />
<br />
Вывод:<br />
<br />
[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]<br />
<br />
=== Удаление правила ===<br />
<br />
svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416<br />
<br />
=== Использование regex ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --keep-time 168h<br />
<br />
Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code><br>Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code><br />
<br />
=== Regex синтаксис ===<br />
<br />
{| class="wikitable"<br />
! Паттерн !! Описание !! Пример<br />
|-<br />
| <code>^</code> || Начало строки || <code>^test</code><br />
|-<br />
| <code>[^x]</code> || Отрицание символов || <code>^[^m].*$</code><br />
|-<br />
| <code>$</code> || Конец строки || <code>test$</code><br />
|-<br />
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c<br />
|-<br />
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123<br />
|-<br />
| <code>.+</code> || Один или более || <code>test.+</code> → test-1<br />
|-<br />
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9<br />
|-<br />
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc<br />
|-<br />
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC<br />
|-<br />
| <code>(a&#124;b)</code> || "a" или "b" || <code>(test&#124;prod)</code><br />
|-<br />
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code><br />
|}<br />
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.<br />
<br />
Для правил отрицания конкретного элемента возможно использовать сложные правила, например:<br />
<br />
<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code><br />
<br />
Данное правило выбирает все ветки, кроме <code>main</code>.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI&diff=3468Help:CLI2026-03-11T10:02:22Z<p>Gribunin: automigrate skip-exist</p>
<hr />
<div>== CLI features ==<br />
=== Перенос снимков ===<br />
Svacer предоставляет возможность по экспорту и импорту снимков посредством интерфейса командной строки и [[Help:UI manual#Работа со снимками|веб-интерфейса]]. Экспорт снимка включает все предупреждения, информацию о снимке, прикрепленные файлы, объект сборки, пользовательские атрибуты, разметку и комментарии. Подавленные предупреждения также включаются в экспортированную информацию и импортируются в статусе подавленных.<br />
<br />
Экспорт и импорт снимков из командной строки доступен пользователям с [[Help:UI manual#Описание ролевой модели|соответствующими правами]] для выбранного проекта/ветки.<br />
<br />
Экспорт снимков:<br />
svacer server export<br />
--user <user> <br />
--password <pwd> <br />
--host <host> <br />
--port <port> <br />
--grpc <grpc port> <br />
--project <project name or id> <br />
--branch <branch name or id> <br />
--snapshot <snapshot name or id> <br />
<output file name><br />
<br />
Импорт снимков:<br />
svacer server import<br />
--user <user> <br />
--password <pwd> <br />
--host <host> <br />
--port <port> <br />
--grpc <grpc port> <br />
--project <project name or id> <br />
--branch <branch name or id> <br />
--name <new name for snapshot><br />
[--force]<br />
<input file name><br />
<br />
Опция '''--force''' создаст проект и ветку, если их не было на сервере.<br />
<br />
=== Создание PDF отчета ===<br />
Для создания PDF отчета по проекту из интерфейса командной строки используется команда '''pdfgen'''. <br />
<br />
Общий вид команды следующий:<br />
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<br />
<br />
* '''cmpMode''' — параметры сравнения. Возможные значения: '''none''' — без сравнения, '''new''' — новые, '''missing''' — отсутствующие, '''matched''' — сопоставленные, '''same''' — одинаковые<br />
* '''project, branch, snapshot''' — параметры, описывающие снимок, отчет для которого требуется создать. В качестве значений могут использоваться как имена, так и идентификаторы соответствующих сущностей. Например: --project zstd --branch "7683ed6a-b838-4090-9945-10e148f94be3" --snapshot zstd_130<br />
* '''target-project, target-branch, target-snapshot''' — параметры, описывающие снимок, с которым необходимо провести сравнение (обязательные параметры для режимов cmpMode: new, missing, matched, same).<br />
* '''file, checker, severity, review''' — параметры, задающие фильтры, применяемые к списку маркеров. Фильтры задают условия включения маркера в отчет. Значения фильтров задаются в формате регулярных выражений. В случае неверного формата, ошибочный фильтр не будет применяться и операция экспорта будет выполнена, как если бы фильтр не был указан. File — фильтр по пути к файлу, где был обнаружен маркер. Checker — фильтр по чекеру, предупреждение от которого было создано. Severity — серьезность сработавшего чекера. Review — статус разметки (confirmed, unclear и т. д.) <br />
* '''out-file''' — имя создаваемого файла отчета. Если не указано расширение, будет добавлено расширение pdf<br />
* '''tz''' — временная зона в минутах. Используется при формировании записи о комментариях, которые оставил пользователь, производивший разметку<br />
* '''lang''' — язык, который будет использован в создаваемом отчете (en — английский, ru — русский)<br />
<br />
Для создания отчета без использования режима сравнения, необходимо указать cmpMode в значение none (это значение используется по умолчанию).<br />
<br />
Для предварительного формирования таблицы маркеров с учетом сравнения, использовать значения cmpMode [new, missing, same, matched]. Названия этих режимов аналогичны названиями в GUI. При этом требуется указание как минимум одного параметра из списка: target-project, target-branch, target-snapshot. Если какие-то параметры target* не указаны, они будут установлены в значение исходных (project -> target-project, branch -> target-branch, ...). Сформированные на предварительном этапе маркеры, проходят механизм фильтраций (параметры: severity, file, review, checker), после чего происходит создание отчета.<br />
<br />
Для создания отчета можно использовать public API:<br />
:URL — /api/public/exportPDF<br />
:Метод — POST<br />
<br />
Тело запроса — JSON, имеет следующий вид: <br />
{<br />
"compare_mode": "new",<br />
"context":{<br />
"project": "zstd",<br />
"branch": "v13",<br />
"snapshot": "zstd_131"<br />
},<br />
"target_context":{<br />
"project": "zstd",<br />
"branch": "v13",<br />
"snapshot": "zstd_132"<br />
},<br />
"language": "en",<br />
"timezone": 180,<br />
"filters": {<br />
"checker": "^Z.*$",<br />
"file": ".*example.*",<br />
"severity": "Cr.*",<br />
"review": "Conf.*"<br />
} <br />
}<br />
<br />
Данный запрос соответствует запросу на создание отчета, который получается в результате сравнения в рамках проекта zstd и ветки v13 двух снимков zstd_131 и zstd_132. При этом будут выбраны только новые маркеры. Среди выбранных останутся только те, что удовлетворяют условиям фильтров, а именно: чекер начинается с буквы Z, файл содержит слово example, серьезность чекера содержит подстроку Cr (что в силу ограниченного количества значений для данного фильтра соответствует значению Critical) в названии, а состояние разметки содержит подстроку Conf (что в силу ограниченного количества значений для данного фильтра соответствует значению Confirmed). Язык отчета — английский, часовой пояс — 180 минут (3 часа).<br />
<br />
=== Импорт разметки из исходного кода ===<br />
Импорт разметки из исходного кода на сервер истории возможен с помощью команды '''svacer markup import''', или с помощью CLI/REST API [[Markup2]].<br />
<br />
Синтаксис:<br />
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]<br />
<br />
Где: <br />
* user, password — пользователь и пароль учетной записи на сервере<br />
* project — проект на сервере, в который будет произведен импорт разметки<br />
* branch — ветка в проекте выбранном выше (по умолчанию master), в которую будет произведен импорт разметки<br />
* snapshot — снимок в выбранных проекте и ветке (по умолчанию последний загруженный), в который будет произведен импорт разметки<br />
* exclude-paths — исключает файлы, соответствующие регулярным выражениям<br />
* template — определяет имя шаблона для импорта разметки (флаг обязательный, в отличие от экспорта)<br />
* from-build-object — при включении этой опции, разметка будет выгружаться из объекта сборки того снимка, который был указан в опциях выше.<br />
<br />
После выполнения команды все комментарии оставленные в коде в соответствии с выбранным шаблоном разметки будут разобраны и добавлены на сервер истории в соответствующий проект, ветку и снимок.<br />
<br />
Для подавления найденных предупреждений следует использовать следующий формат разметки в исходном коде<br />
<br />
//svacer_review: -<warn class>[|-<warn class>]+ <br />
<br />
Пример: <br />
<br />
if (!strncmp("--filelimit",argv[i],11)) {<br />
j = 11; //svacer_review: -UNUSED_VALUE<br />
if (*(argv[i]+11) == '=') {<br />
<br />
Комментарий должен быть расположен в конце строки, где ожидается предупреждение от анализатора Svace.<br />
<br />
Для импорта разметки при использовании команд '''import --upload''' и '''upload''' следует указывать флаг '''--template <template>'''. В таком случае разметка будет импортирована из объекта сборки сразу после загрузки его на сервер.<br />
<br />
==== Шаблон разметки DEFAULT ====<br />
Сервер позволяет добавить собственные шаблоны разметки, для удобства добавлен неудаляемый шаблон DEFAULT. Список шаблонов можно увидеть в '''Settings > Markup templates''' (при наличии прав доступа).<br />
<br />
Шаблон можно использовать как для импорта, так и для экспорта разметки, поэтому можно проверить ожидаемый формат через [[Help:UI manual#Экспорт кода с разметкой|выгрузку кода]] с указанием шаблона.<br />
<br />
В шаблоне DEFAULT каждая разметка описывается на отдельной строчке перед маркером, при необходимости можно использовать несколько строчек. Импорт разметки с неправильным статусом или со статусом Undecided не производится, включая комментарии к ней.<br />
<br />
Пример:<br />
<br />
//svacer_review: FORMAT_STRING.PARAM_EXCESS r:Confirmed|s:Minor|a:Undecided|c:<br />
//svacer_review: UNINIT.LOCAL_VAR r:Confirmed|s:Unspecified|a:Fix required|c:will be fixed<br />
printf("v = %d", fl3(), i);<br />
<br />
Разметка нескольких одинаковых предупреждений на одной строчке проблематична, гарантируется только что разметка будет применена к маркеру с таким названием.<br />
<br />
=== Изменение инвариантов (--path-prefix) ===<br />
Если на сервер был загружен снимок, в котором расположение некоторых (или всех) файлов поменялось, а при импорте не был указан флаг '''--path-prefix''', то разметка с прошлого снимка не распространится на новый снимок. Для решения данной проблемы следует использовать команду '''svacer markup update'''.<br />
<br />
Синтаксис:<br />
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]<br />
<br />
Где: <br />
* user, password — пользователь и пароль учетной записи на сервере<br />
* project — проект на сервере, в котором будет обновлена разметка<br />
* branch — ветка в проекте выбранном выше (по умолчанию master), в которой будет обновлена разметка<br />
* path-prefix — правило отображения для префиксов путей в формате: <file> или line prefix:replacement;prefix:replacement<br />
<br />
В конце команды опционально могут быть указаны имена или идентификаторы снимков, в которых будет обновлена разметка в соответствии с указанными префиксами путей. Если они указаны не будут, изменения будут применены ко всей ветке. После запуска команды на сервер будет отправлен асинхронный запрос на обновление разметки, за дальнейшим прогрессом исполнения можно следить в логе сервера (через UI он доступен пользователям с ролью admin в '''Settings > Server information''').<br />
<br />
=== Изменение инвариантов (--edit-markers) ===<br />
При импорте снимка с использованием --edit-markers можно модифицировать маркеры более гибко, см [[Edit markers (command line)]]<br />
<br />
=== Подавление предупреждений ===<br />
Для подавление выбранных пользователем предупреждений предоставляется следующий интерфейс командной строки:<br />
<br />
Список подавленных предупреждений (печатает JSON)<br />
svacer markup [auth/selection] suppress list<br />
<br />
Пример<br />
svacer markup --user admin --password admin --project tree-command suppress list<br />
<br />
<br />
Подавить предупреждение<br />
svacer markup [auth/selection] suppress add id1 id2 id3<br />
<br />
Пример<br />
svacer markup --user admin --password admin --project tree-command suppress add 29d298cd-752d-4d19-b535-2089a72a96af<br />
<br />
<br />
Убрать подавление предупреждения<br />
svacer markup [auth/selection] suppress remove id1 id2 id3<br />
<br />
Пример<br />
svacer markup --user admin --password admin --project tree-command suppress remove 29d298cd-752d-4d19-b535-2089a72a96af<br />
<br />
<br />
Убрать все подавления<br />
svacer markup [auth/selection] suppress remove<br />
<br />
Пример<br />
svacer markup --user admin --password admin --project tree-command suppress remove<br />
<br />
Список предупреждений с ID доступен посредством public REST API. Функциональность предназначена для интеграции со сторонними инструментами и встраивания в CI/CD pipeline.<br />
На текущий момент информация о подавленных предупреждениях недоступна в веб-интерфейсе.<br />
<br />
При экспортировании снимка где есть подавленные предупреждения, сами предупреждения будут так же экспортированы как подавленные.<br />
<br />
=== Автомиграция разметки ===<br />
В Svacer возможно настроить автомиграцию разметки с ветки на ветку (у пользователя должны быть права на администрирование сервера).<br />
<br />
svacer server automigrate [command] [flags]<br />
<br />
Существующие command:<br />
* add — добавляет автомиграцию в соответствии с паттерном<br />
* delete — удаляет автомиграцию<br />
* show_config — показывает все заданные миграции (Config Table), их id, время создания и пользователя, который их создал<br />
* show_automigrate — показывает таблицу всех существующих проектов и веток с которых и на которые происходят автоматические миграции (Automigrate Table)<br />
* log — выводит список всех совершенных миграций (Done Automigrate Table)<br />
<br />
Флаг '''pattern''', применяется для команд <code><add|delete|show_config|log></code><br />
<br />
* Для '''add''': Паттерн автомиграции в формате: <code>srcProject{id|name}/srcBranch{id|name}=>receiveProject{id|name|regEx}/receiveBranch{id|name|regEx}</code><br />
:regEx — в [https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP формате как для PostgreSQL]<br />
<br />
* Для '''delete''': Паттерн автомиграции в формате: <code>srcProject{id|name}/srcBranch{id|name}=>receiveProject{id|name|regEx}/receiveBranch{id|name|regEx}</code><br />
:Паттерн должен быть точно таким же, как он записан в Config Table<br />
<br />
* Для '''show_config''': Паттерн автомиграции. Поиск будет происходить в следующем виде: <code>ILIKE "'%"+pattern+"%'"</code><br />
<br />
* Для '''log''': Флаг в формате <code>srcProjectId/srcBranchId=>receiveProjectId/receiveBranchId</code> или <code>srcProjectName/srcBranchName=>receiveProjectName/receiveBranchName</code> для вывода автомиграций с данным паттерном<br />
<br />
Флаг '''id''', применяется для command <code><delete|show_automigrate></code> в формате uuid<br />
<br />
* Для '''delete''': id для удаления автомиграции (из Config Table)<br />
<br />
* Для '''show_automigrate''': id ветки/проекта или конфигурации для нахождения его в таблице автомиграций (Automigrate Table) и вывода автомиграций, где присутствует данный id<br />
<br />
Флаг '''format''' — формат вывода таблицы. Применяется для command <code><show_config|show_automigrate|log></code><br />
<br />
* Для '''show_config''':<br />
:* table — вывод в виде таблицы<br />
:* json — вывод в виде json<br />
:* no-id — вывод без config id<br />
:Значения можно перечислить через запятую: <code>json,no-id</code>. По умолчанию — table.<br />
<br />
* Для '''show_automigrate|log''':<br />
:* table — вывод в виде таблицы<br />
:* json — вывод в виде json<br />
:По умолчанию — table.<br />
Флаг '''skip-exist''' — укажите данный флаг, чтобы не возвращать ошибку, если паттерн уже существует. Применяется для команды <code>add</code>.<br />
<br />
Также возможно использовать POST запрос по адресу <code>/api/automigrate</code>. В теле передается json, с полями <code>action(not null), pattern, id</code>. Выполняется по тому же принципу, что и в CLI.<br />
<br />
Принцип работы сервиса: <br />
* При запуске сервера запускается сервис automigrate<br />
* При занесении новой миграции, находит все миграции, подходящие под паттерн, и копирует разметку на них<br />
* При удалении миграции, удаляет её из таблицы Config и удаляет из таблицы автомиграций<br />
* '''Может''' копировать разметку с нескольких веток на одну, а также поддерживает цепочки и циклы автомиграций (например 1->2->3->1)<br />
<br />
* При любом изменении разметки у существующих веток (добавление/удаление/изменение комментариев, добавление снимка, добавление проекта, добавление ветки, изменение имени ветки/проекта, удаление контейнера, удаление снимка) происходит либо миграция разметки, либо добавление новых миграций в таблицу автомиграций и миграция разметки, либо удаление миграции из таблицы автомиграций (в зависимости от конкретной ситуации). При какой-либо ошибке выдает предупреждение, но даёт выполнить действие.<br />
<br />
* Единственный случай, когда сервис не даёт выполнить действие — загрузка результатов Svace через CLI: upload, либо import с флагом --upload. В этом случае сервис выдает ошибку миграции и отменяет загрузку. Такое может произойти, когда имя данной ветки (в качестве to_branch) подходит под несколько паттернов.<br />
* Копируется последняя примененная разметка<br />
<br />
=== Аутентификация из переменных окружения ===<br />
Пользователь может использовать следующие переменные окружения для выполнения аутентификации при использовании CLI<br />
SVACER_AUTH_CREDS=login:password<br />
SVACER_AUTH_TOKEN=token<br />
В качестве токена нужно использовать токен, получаемый через REST endpoint <code>/api/public/login</code><br />
<br />
Также пользователь может задать переменную окружения SVACER_APP_KEY или передать в CLI ключ <code>--app-key</code> для указания ключа подписи выдаваемых сервером Bearer токенов. Это позволит избежать необходимости повторого логина в веб интерфейсе Svacer после его перезапуска. Кроме того, сторонее приложение также сможет выдавать Bearer токены для сервера Svacer, которые сервер будет рассматривать как подлинные.<br />
<br />
=== Personal Access Token ===<br />
Svacer поддерживает работу с Personal Access Token для аутентификации. Для этого используется команда <code>svacer server token</code><br />
<br />
Команда позволяет:<br />
<br />
* Создавать токены. Параметры <code>name</code>, <code>ttl</code> обязательны. TTL указывается в днях<br />
svacer server token create --name token_name --ttl day_to_live --details more_info<br />
* Просмотреть список созданных токенов<br />
svacer server token list<br />
* Удалить токен<br />
svacer server token delete --id token_id<br />
* Управлять токенами других пользователей (требуется наличие прав по управлению пользователями)<br />
svacer server token admin list --user user_id_or_login — получение списка токенов пользователя<br />
svacer server token admin delete --id token_id — удаление токена<br />
<br />
Сейчас наложено единственное ограничение на создаваемые токены — нельзя с помощью такого токена создавать другие токены. Каждый пользователь может создавать токены также через public API: <code>/api/public/personal_token</code>. См. описание swagger.<br />
<br />
Управлять токенами также можно в [[Help:UI manual#Управление токенами доступа|UI Svacer]].<br />
<br />
Созданные токены можно в дальнейшем использовать в качестве значения переменной окружения <code>SVACER_AUTH_TOKEN</code>.<br />
<br />
=== Вывод списка предупреждений ===<br />
Пользователь может получить таблицу предупреждений с сервера, используя команду<br />
<br />
svacer marker list --host host --user user --password password --project project_name_or_id --branch branch_name_or_id --snapshot snapshot_name_or_id<br />
<br />
Вывод:<br />
# warn file line review msg <br />
1000 INVARIANT_RESULT /.build/subst.c 7080 Expression 'tl->word->flags | (1 << 21)' is always <br />
true , which may be caused by a logical error <br />
1001 DEREF_AFTER_NULL.LOOP /.build/execute_cmd.c 3327 After having been compared to NULL value at execut <br />
e_cmd.c:3325, pointer 'l' is dereferenced at execu <br />
te_cmd.c:3327. <br />
1002 DEREF_AFTER_NULL.LOOP /.build/variables.c 2749 After having been compared to NULL value at variab <br />
les.c:2656, pointer 'vc' is dereferenced at variab <br />
les.c:2749. <br />
1003 CHECK_AFTER_PASS_TO_PROC /.build/redir.c 1219 Variable 'redirector' was passed to function at re <br />
dir.c:1215 by calling function 'fcntl' that can't <br />
use negative values is checked for negative value <br />
at redir.c:1219. <br />
<br />
При указании флага <code>--out-format=json</code> вывод будет произведен в JSON формате:<br />
<br />
[{"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,"<br />
<br />
=== Слияние снимков из CLI (экспериментальная опция) ===<br />
Пользователь может объединить несколько снимков в один используя команду<br />
svacer container snapshot merge --host host --user user --password password --branch target_branch --name target_snapshot_name --snapshot val1 --snapshot val2 --snapshot val3 ...<br />
При указании снимков для слияния и целевой ветки, пользователь может использовать либо UUID объектов либо формат<br />
целевая ветка: <project name>:::<branch name><br />
снимок: <project name>:::<branch name>:::<snapshot name><br />
При слиянии можно использовать снимки из разных проектов и веток. Пользователь должен иметь доступ на чтение ко всем снимкам и на запись для целевой ветки<br />
<br />
=== Управление контейнерами ===<br />
См. [[Help:CLI/management/containers]]<br />
<br />
=== Управление пользователями и ролями ===<br />
См. [[User Management (command line)]]<br />
<br />
=== Автоматическое удаление снимков ===<br />
См. [[Help:CLI/cleanup]]<br />
<br />
== Svacer server features ==<br />
<br />
=== Запуск с конфиг-файлом ===<br />
svacer-server run --config config.yml<br />
<br />
'''--config <value>''' — путь к файлу конфигураций в формате YAML (по умолчанию svacer.cfg)<br />
<br />
=== Поддержка сквозной аутентификации ===<br />
Svacer поддерживает сквозную аутентификацию через reverse proxy. Для этого используется опция proxy-mode. При включении этой опции есть возможность проходить аутентификацию (используя HTTP Basic Authentication) на reverse proxy сервере и использовать эти данные для аутентификации на сервере Svacer.<br />
<br />
При включенном proxy-mode используется header с прокси '''Authorization Basic ...''', откуда Svacer берет имя пользователя и пароль, проверяет и аутентифицирует пользователя, если аккаунт с таким логином и паролем есть в БД пользователей Svacer.<br />
<br />
Пример запуска сервера с поддержкой сквозной аутентификации:<br />
<br />
svacer-server run --proxy-mode<br />
<br />
=== Хуки ===<br />
Для использования хуков при запуске сервера нужно указать опцию '''--hooks <path to JSON file>'''. Эта опция задаёт файл, содержащий описание хуков, которые пользователь может вызывать из web-интерфейса. Каждый хук соответствует процессу или скрипту, который сервер запускает при вызове соответствующей команды из web-интерфейса.<br />
<br />
Формат файла описания хуков следующий:<br />
{<br />
"hooks": [<br />
{<br />
"id": "<id>",<br />
"label": "<label >",<br />
"target": "<target>",<br />
"input": ["<param1>", "<param2>", ...],<br />
"cmd": "<path to executable>",<br />
"args": ["<arg1>", “<arg2>”, ...]<br />
},<br />
...<br />
]<br />
}<br />
<br />
'''Параметры хуков '''<br />
{| class="wikitable"<br />
| style="width:100px;" | ''id''<br />
| Идентификатор хука. Должен быть уникальным в файле<br />
|-<br />
| ''label''<br />
| Имя команды, которую пользователь видит в web-интерфейсе<br />
|-<br />
| ''target''<br />
| Место в UI, в которое будет добавлена команда. Сейчас поддерживается только одно значение — default. Оно соответствует вкладке Details на правой панели пользовательского интерфейса<br />
|-<br />
| ''input''<br />
| Параметры, которые можно передать в запускаемый процесс, исходя из контекста вызова команды в web-интерфейсе. <br/><br />
Поддерживаемые значения:<br />
* markerID — UUID идентификатор маркера;<br />
* branchID — UUID идентификатор ветки;<br />
* snapshotID — UUID идентификатор снимка;<br />
* projectID — UUID идентификатор проекта;<br />
* url — URL маркера в web-интерфейсе, на котором была вызвана команда;<br />
* marker — будет заменен на полное имя временного файла, содержащего сериализованное в JSON представление маркера, который включает в себя его трассу и информацию о разметке<br />
|-<br />
| ''cmd''<br />
| Полный путь к процессу, который будет запущен. Не должен включать аргументы запуска<br />
|-<br />
| ''args''<br />
| Аргументы, передаваемые в запускаемый процесс. Полный список аргументов запускаемого процесса состоит из списка <args> и списка значений, соответствующих полю <input><br />
|}<br />
<br />
Типичный сценарий использования хуков — создание кейсов для выбранного предупреждения в системах отслеживания ошибок, таких как Jira или Gitlab. Примеры скриптов для этого можно найти на странице [[Примеры использования хуков]].<br />
<br />
=== Ограничение числа запросов ===<br />
Чтобы ограничить число запросов на сервер Svacer, перед запуском сервера определите переменную окружения со следующими параметрами<br />
<br />
SVACER_SERVER_THROTTLE_PARAMS=limit,backlogLimit,timeout<br />
<br />
* limit — число одновременных запросов <br />
* backlogLimit — размер бэклога для запросов, которые нельзя обработать сейчас <br />
* timeout — время ожидания запроса в бэклоге (формат 1m12s — duration)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Changelog&diff=3463Changelog2026-02-09T07:57:47Z<p>Gribunin: changelog add retry-policy</p>
<hr />
<div>=== Release 12-0-1 ===<br />
<br />
* Убраны ограничения на размер поля advanced filter в пользовательских фильтрах<br />
* В публичных запросах возвращающих маркеры добавлено поле <code>checker_situation</code> соответствующее полю `situation` в детекторах<br />
* Добавлена возможность фильтрации по <code>checker_situation</code> в advanced filter<br />
* Добавлена возможность фильтрации по <code>checker_labels</code> в advanced filter<br />
* Добавлен публичный фильтр по детекторам, соответствующим <code>ГОСТ 71207-2024</code> . Импортировано описание детекторов из <code>Svace version 5.0.251220</code><br />
* При миграции со старых версий баз (а так же при миграциях, связанных с изменением схемы генерации инвариантов) реализовано полное сохранение разметки и комментариев на маркерах и последующее восстановление пропущенных, после миграций, разметок и комментариев (при обнаружении таковых)<br />
* Вынесен ряд timeout-ов на уровень переменных окружения для адаптации под пользовательские сценарии<br />
* Добавлена подсветка синтаксиса для языка Lua<br />
* Исправлены проблемы безопасности, связанные с импортом данных и механизмом токенов доступа (PAT)<br />
* При загрузке снимков, svace-dir и разметки через командную строку появилась возможность указать флаг <code>retry-policy</code>, который задает время ожидания ответа от сервера, количество дополнительных попыток и задержка между повторами, например <code>30m:10:1m</code><br />
<br />
=== Release 12-0-0 ===<br />
28.11.2025<br />
<br />
* API методы на fullmarkers позволяют [[Help:Public API#Примеры использования фильтров в public api|указать фильтр]] с полем фильтрации по checker reliability<br />
* В функциональность полнотекстового поиска добавлен поиск маркеров по id и инварианту<br />
* Промежуточное хранилище при импорте результатов командой <code>svacer import / svacer sarif2 import</code> теперь использует новый формат представления. Это должно снизить использование памяти при импорте<br />
* Сериализация JSON переведена на jsonv2 библиотеку в Go<br />
* Импорт SARIF теперь более устойчив к пропускам в файле (отсутствие таких полей как location)<br />
* Добавлены переменные окружения <code>SVACER_TIMEOUT_IMPORT_RESULTS</code> для [[Help:Configuration#Переменные окружения|контроля таймаута]] на ожидание начала импорта результатов и <code>SVACER_NUM_PARALLEL_IMPORTS</code> на [[Help:Configuration#Переменные окружения|ограничение числа параллельных импортов]]. По умолчанию значения 15 минут и <code>(максимальное число коннектов к БД) / 2</code>. Ограничения необходимы для предотвращения бесконечных ожиданий и зависаний при импорте данных<br />
* Убраны лишние сообщения об устаревших детекторах при старте сервера или импорте снимков<br />
* В метрики Prometheus добавлен ряд показателей размеров object store<br />
* Размер лога сервера, показываемого в Web-интерфейсе, ограничен. Размер [[Help:Configuration#Переменные окружения|задается переменной окружения]] SVACER_TAIL_LOG_SIZE (по умолчанию 1Мб). Показывается последний кусок не более SVACER_TAIL_LOG_SIZE. Сам лог файл не ограничивается в размерах и кнопка выгрузки лога выгружает полный лог<br />
* ['''Экспериментально'''] Можно [[Help:Configuration#Переменные окружения|указать JSON-формат]] лог-файла посредством параметра <code>svacer-server --log-format=json ...</code>, также формат может быть указан через переменную окружения <code>SVACER_LOG_FORMAT=json</code>. Опции также работают для CLI-клиента svacer<br />
* При запуске сервера можно указать флаг <code>--force-invariant-refresh</code> для принудительной регенерации инвариантов. Это может решить проблему с переносом разметки<br />
* Добавлена переменная окружения SVACER_INV_GEN_JOBS для контроля числа параллельных заданий при регенерации инвариантов. При ограниченных ресурсах машины рекомендуем ставить значение 2. По умолчанию значение ставится в 70% от <code>runtime.GOMAXPROCS</code><br />
* Добавлена функциональность по чистке object store при удалении снимков<br />
* Добавлена возможность создания [[Afilters|сложных пользовательских фильтров]] по условиям, выраженным предикатом <br />
* Проведена работа по предотвращению зависаний при исчерпывании доступных соединений с PostgreSQL сервером<br />
* Добавлен файл с чексуммой бинарника сервера <code>svacer-server</code> и проверка чексуммы при запуске<br />
* Упростили [[Help:XSvacer:AIAssistant#Активация и запуск ИИ-ассистента|деплой ИИ-ассистента]]: добавили его сервис в docker-compose и deb/rpm пакеты<br />
* Расширили возможности конфигурации при запуске сервера через [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose]: теперь можно включить debug, указать конфиг LDAP и параметр public-url<br />
* Добавлена возможность указания минимального количества снимков, которое необходимо оставлять в ветке, тип очистки и период удаления в [[Help:CLI/cleanup|автоматическом удалении снимков]]<br />
* ['''Экспериментально'''] Добавлена возможность [[Edit markers (command line)|автоматически обрабатывать маркеры]] при импорте данных. Также обработка маркеров доступна через [[Help:UI manual#Работа со снимками|UI]]<br />
* Добавлен флаг <code>diff-url</code> для команды <code>quickdiff</code> в CLI, также как и для команд <code>import</code>, <code>upload</code>, <code>sarif2 import</code> с указанием опции <code>quick-stat</code>. Данный флаг позволяет получать ссылку на diff снимков<br />
* Добавлены предупреждения если в командах <code>import</code>, <code>sarif2 import</code> используются флаги, которые используются флагом <code>upload</code>, но флаг <code>upload</code> не установлен <br />
* Добавлена интеграция с внешними системами посредством механизма [[Help:Configuration#Механизм интеграции с внешними системами посредством Webhook-ов|Webhooks]]<br />
* Добавлена [[Help:Configuration#Настройка защиты от перебора паролей пользователей|защита от перебора пароля пользователя]]<br />
* Добавлена возможность задать [[Help:Configuration#Настройка парольной политики внутреннего механизма аутентификации Svacer|парольную политику безопасности]] для пользователей, использующих встроенный механизм аутентификации Svacer <br />
* Добавлена возможность задать [[Help:Configuration#Задание вкладки по умолчанию на странице входа в GUI Svacer (а также отключение внутреннего механизма аутентификации Svacer)|вкладку по умолчанию]] для страницы входа в систему <br />
* Исправлена ошибка, приводящая к разрастанию базы данных<br />
* Исправлена ошибка, связанная с невозможностью в ряде случаев использовать механизм подписок<br />
* Форма [[Help:UI manual#Разметка маркера с помощью ассистента AI|разметки]] с помощью [[Help:XSvacer:AIAssistant|ИИ-ассистента]] реализована в основном интерфейсе Svacer<br />
* [[Help:XSvacer:Webide#Запуск функциональности при использовании docker compose|Упрощён запуск функциональности Webide]] при запуске сервера через [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose]<br />
<br />
=== Release 11-2-0 ===<br />
22.07.2025<br />
<br />
* Исправлены зависания сервера<br />
* Добавлено автоматическое удаление архивов и прочих временных файлов при импорте .svace-dir и SARIF-файлов через REST API<br />
<br />
=== Release 11-1-0 ===<br />
08.07.2025<br />
<br />
* Команды <code>--project-group, --if-no-group, --autoclean, --autoclean-svace</code> можно использовать в REST API для импорта svace-dir<br />
* При использовании REST API для импорта svace-dir сервер будет автоматически удалять директории <code>.svace-dir</code> и <code>.svacer</code> если не указаны явные опции <code>--autoclean=false, --autoclean-svace=false</code><br />
* Добавлена опция запуска сервера <code>--classic-inv-mode</code> для включения режима совместимости по генерации инвариантов с версией <= 8.x.x<br />
* Исправлены ошибки в работе <code>--quality-gate</code>, добавлена возможность учета статусов разметки. Добавлена возможность [[Help:Import from Svace#Флаг --baseline|указания baseline]] для сравнений при использовании опции <code>--quality-gate</code><br />
* Исправлены ошибки при подключении к PostgreSQL в SSL-режиме<br />
* Исправлен ряд ошибок при работе с LDAP<br />
* Команда <code>quickdiff</code> в CLI теперь выдает информацию также о Same и Matched предупреждениях<br />
<br />
=== Release 11-0-0 ===<br />
19.05.2025<br />
<br />
* Убраны излишние сообщения в логе сервера о login/logout операциях. Они будут выводиться только при запуске сервера с опцией <code>--debug</code><br />
* Команды CLI <code>svacer sarif *</code> были убраны, для [[Help:Sarif|импорта и экспорта]] следует использовать <code>svacer sarif2 *</code><br />
* Экспорт SARIF теперь включает все комментарии как отдельные объекты в <code>Properties</code><br />
* При экспорте в SARIF теперь экспортируются поля <code>Labels, Orig function</code><br />
* Импорт SARIF теперь корректным образом учитывает relatedLocations и формирует трассу<br />
* Импорт SARIF теперь автоматически импортирует исходники, если они включены в сам SARIF файл<br />
* Добавлена возможность указания [[Help:Sarif#Мэппинг severity|мэппинга severity]] детекторов при импорте из SARIF<br />
* Добавлен механизм указания правил резолвинга путей при импортировании исходного кода вместе с SARIF файлом<br />
* Экспорт исходников из снимка будет доступен только при наличии исходников на сервере<br />
* Добавлены флаги <code>--autoclean</code>, <code>--autoclean-svace</code> в команду <code>svacer import</code> для автоматического удаления <code>.svace-dir / .svacer-dir</code> после успешного импорта и загрузки данных на сервер<br />
* Улучшена поддержка [[OIDC]]<br />
* Улучшена поддержка [[LDAP configuration|LDAP]]<br />
* Добавлена интеграция с хранилищем секретов [[Infisical]]<br />
* Добавлена [[Notifications|служба нотификаций]] пользователей через почтовые сообщения и мессенджер telegram<br />
* Добавлен механизм аутентификации и [[Help:UI manual#Управление токенами доступа|управления]] персональными токенами доступа<br />
* Добавлен механизм упоминания пользователей через специальную конструкцию @login в комментариях к разметке<br />
* В разделе Статистика добавлен дашборд с [[Release notes 11-0-0#Изменения в разделе Статистика|Общей статистикой]], содержащей метрики по последним импортированным снимкам в ветках проектов<br />
* В статистике по активности пользователей добавлена возможность просмотра панели с актуальной информацией о маркере и опция показа только действий с актуальной разметкой<br />
* Большинство CLI команд, работающих с сервером, теперь делают явный logout после завершения<br />
* Svacer при импорте результатов Svace автоматически импортирует файлы <code>*.warn, *.err</code> с предупреждениями от самого анализатора Svace. Автоматический импорт не будет происходить при размере этих файлов более 30Мб (большой размер может свидетельствовать о проблемах в ходе анализа)<br />
* Переменная окружения <code>SVACER_CACHE_DIR</code> теперь учитывается во всех местах (ранее в ряде случаев мог неявно использоваться <code>$HOME/.cache</code>)<br />
* Добавлена возможность [[Help:CLI/cleanup|автоматического удаления снимков]]<br />
<br />
=== Release 10-0-1 ===<br />
17.02.2025<br />
<br />
* Исправлена ошибка с временной таблицей при обработке планов автомиграции разметки при импорте результатов (ERROR: relation "loaded_review" already exists)<br />
<br />
=== Release 10-0-0 ===<br />
16.01.2025<br />
<br />
* Множество изменений в UI, смотрите [[Release notes 10-0-0]]<br />
* Сделали [[Help:Installation#deb/rpm|dnf/yum репозиторий]] для RPM-пакетов Svacer<br />
* Реализована возможность [[Markup2|экспорта, импорта и копирования разметки посредством Public REST API и CLI]]<br />
* Реализован дополнительный экспериментальный механизм [[Help:UI manual#Настройка интерфейса|генерации PDF на основе HTML]]. Генерация PDF переведена на асинхронный режим с показом нотификации пользователю<br />
* Добавлена возможность очистки всей разметки и/или комментариев на ветке проекта<br />
* Улучшения функциональности просмотра маркеров в встроенном IDE Theia<br />
* Добавлена функциональность по [[Help:UI manual#Глобальный поиск|глобальному поиску]] маркеров, комментариев и снимков по различным атрибутам<br />
* Добавлена возможность [[Help:UI manual#Просмотр статистики|получения статистики]] по маркерам и активностям пользователей при разметке<br />
* В API fullmarkers добавлен параметр <code>labels: true/false</code> для выгрузки меток маркера<br />
* Реализован Public API для получения/добавления/удаления меток маркеров<br />
* Настройки LDAP и прочие настройки аутентификации добавлены в единый конфигурационный файл<br />
* Добавлена возможность удаления кода из снимка при частичном импорте в Svacer<br />
* Добавлена опция minVersion, maxVersion для TLS при запуске сервера Svacer<br />
* Добавлена поддержка групп проектов при импорте снимков в CLI<br />
* При импорте снимков реализована поддержка автоматического определения пути префикса для переноса разметки<br />
* Исправлен ряд ошибок в импорте и генерации [[Help:Sarif|SARIF]]<br />
* Исправлены ошибки в копировании разметки между ветками, клонировании проектов и веток<br />
* Добавлена возможность отключения бэкграунд задач по очистке мусора<br />
* Добавлено экспериментальное CLI API для просмотра асинхронных задач на генерацию PDF<br />
* Добавлена возможность визуализации производительности сервера на основе [https://github.com/arl/statsviz statsviz]<br />
* Добавлена поддержка относительных путей в svres файле<br />
* Добавлена возможность ожидания завершения операций по очистки мусора при выполнении операций по импорту результатов анализа<br />
* Добавлена поддержка CWE таксономий при экспорте [[Help:Sarif|SARIF]]<br />
* Добавлена переменная окружения SVACER_TOKEN_LIFETIME для управления временем жизни токена аутентификации<br />
* Добавлена переменная окружения SVACER_RESET_ADMIN_PASSWORD для явного указания желаемого пароля при операции по сбросу пароля администратора<br />
* Добавлен [[Notifications|механизм нотификаций пользователей]] о внутренних событиях Svacer (экспериментальный функционал)<br />
<br />
=== Release 9-0-2 ===<br />
22.07.2024<br />
<br />
* Еще некоторые исправления, связанные с миграцией данных<br />
* Исправлена проблема с навигацией по Go to Definition<br />
<br />
=== Release 9-0-1 ===<br />
15.07.2024<br />
<br />
* Исправлены ошибки в клонировании проектов, приводящие к размножению записей в некоторых внутренних таблицах<br />
* Различные исправления, связанные с миграцией данных<br />
* Исправлена работа ряда CLI команд с включенным TLS на сервере<br />
* Исправлен ряд ошибок в генерации PDF<br />
<br />
=== Release 9-0-0 ===<br />
04.06.2024<br />
<br />
* Множество изменений в UI, смотрите [[Release notes 9-0-0]]<br />
* Svacer разделен на два исполняемых файла: <code>svacer-server</code> — сервер и <code>svacer</code> — клиент<br />
* {{Note}}Object store заменен на другую реализацию. Конвертация данных запускается автоматически при апгрейде и требует примерно 2х-2.2х дискового пространства, после конвертации старый object store будет удален. Время конвертации зависит от объема данных и скорости диска<br />
* {{Note}}Изменен [[Help:Match|алгоритм сопоставления предупреждений]]. При старте сервера будет произведена регенерация всех инвариантов во всех ветках. Это может занять продолжительное время (зависит от мощности сервера и объемов данных)<br />
* Добавлена возможность [[Help:Match#Ручное сопоставление предупреждений (экспериментальная возможность)|ручного сопоставления предупреждений]] для переноса разметки<br />
* Добавлена экспериментальная поддержка [[OIDC|OpenID]] протокола для аутентификации<br />
* Добавлена экспериментальная возможность [[Help:CLI#Слияние снимков из CLI (экспериментальная опция)|слияния снимков через CLI]]<br />
* Исправлены баги в [[Help:Sarif|импорте Sarif]], добавлена поддержка импорта с относительными путями к файлам (флаг <code>--base-dir</code>)<br />
* Лог сервера работает в режиме append, прежние данные не затираются<br />
* Добавлена возможность передачи токена аутентификации в клиент Svacer через переменную окружения <code>SVACER_AUTH_TOKEN=token</code><br />
* Добавлена возможность передачи логина и пароля в клиент Svacer через переменную окружения <code>SVACER_AUTH_CREDS=login:password</code><br />
* Добавлен public REST endpoint для импорта <code>.svace-dir</code> на стороне сервера<br />
* Добавлена возможность импорта <code>.svace-dir</code> из веб-интерфейса<br />
* Добавлены [[Metrics|метрики]] для Prometheus, доступны при запуске сервера с переменной окружения <code>SVACER_TRACE_OPTIONS=prom_metrics_on</code> на <code>/api/metrics</code><br />
* Добавлена очистка БД от мусора с возможностью настройки периодичности данной операции через переменную окружения <code>SVACER_GC_PERIOD=val</code> где val — duration в формате <code>hhmmss</code> или [https://en.wikipedia.org/wiki/Cron Cron]<br />
* Добавлена возможность клонирования проектов<br />
* Добавлен импорт <code>*warn, *.err</code> файлов из <code>.svace-dir</code>, которые содержат диагностические сообщения от Svace<br />
* Добавлена возможность [[Help:CLI#Ограничение числа запросов|ограничения числа запросов]] на сервер с указанием параметров в переменной окружения <code>SVACER_SERVER_THROTTLE_PARAMS</code><br />
* Добавлен шаблон для импорта разметки из кода на Go: <code>DEFAULT_GO</code><br />
* Добавлена возможность [[Help:CLI#Аутентификация из файла|аутентификации из файла]]<br />
* Исправлены проблемы безопасности<br />
* Добавлена возможность просмотра исходного кода снимка с предупреждениями анализатора во внешней IDE собранной на базе [https://theia-ide.org/ Theia IDE]<br />
* К команде automigrate add в CLI добавлен флаг <code>skip-exist</code>, чтобы при добавлении паттерна, который уже существует, не выдавало ошибки <br />
* К команде upload (import с флагом upload) с указанием флага <code>quality-gate</code> теперь можно добавить флаг <code>quality-gate-verbose</code>. Если его указать, то также будет выведен результат успешных проверок quality-gate<br />
* Улучшения в поддержке протокола LDAP<br />
<br />
=== Release 8-0-1 ===<br />
22.01.2024<br />
<br />
* Исправлена работа в изолированной от сети среде. Загрузка Web UI больше не требует доступа к публичным CDN<br />
* Добавлена поддержка функций при указании пользовательского фильтра<br />
* Добавлено API для управления пользовательскими фильтрами. Детали и пример использования можно найти здесь: https://gitlab.ispras.ru/svacer-public/api-go-examples/-/tree/master/api-ui-settings<br />
* Исправлено отображение Checker Severity при экспорте в SARIF. Теперь Critical -> error; Major, Normal -> warning; Minor -> note; any other -> warning<br />
<br />
=== Release 8-0-0 ===<br />
21.11.2023<br />
<br />
* Множество изменений в UI. Смотрите обзор в [[Release notes 8-0-0]]<br />
* Добавлен новый импорт и экспорт из SARIF в command line с поддержкой исходного кода в SARIF файлах и импортом описания детекторов из SARIF<br />
* Добавлены группы проектов<br />
* Переделана модель ролей и доступов. Добавлен CLI для управления ролями и доступами<br />
* Добавлена возможность настройки автопереноса разметки между ветками, в том числе в разных проектах<br />
* Импорт/экспорт снимков включает информацию о детекторах<br />
* Исправлена работа интерфейса с Undefined детекторами (т. е. детекторами, информация о которых отсутствует в Svacer)<br />
* Добавлено экспериментальное API по управлению детекторами и конфигурациями детекторов<br />
* Добавлена очистка исходного кода от Svacer-specific комментариев перед экспортом разметки в код<br />
* Добавлена возможность включения режима обязательного комментария при разметке кода. Комментарий будет сгруппирован с операцией разметки и будет иметь ссылку на нее<br />
* Утилита миграции со старого svace-сервера больше не поддерживается. При необходимости миграции используйте утилиту из прошлых релизов Svacer<br />
* Добавлена Swagger документация на API<br />
* Добавлено хранение истории изменений комментариев<br />
* Опция <code>--pathPrefix</code> поддерживает файлы в JSON формате вида: <code>[{ "prefix": "/some/path", "replace": "/test" }, ...]</code><br />
* При использовании операции по обновлению <code>pathPrefix</code> на сервере, данные о прежнем <code>pathPrefix</code> запоминаются в мета-информации о снимке<br />
* Добавлена возможность переименования снимков в UI<br />
* Sensitive информация (детали подключения к БД с данными аутентификации) убрана из UI и API<br />
* ОС в docker-образе Svacer обновлена с Ubuntu 18 до Ubuntu 22<br />
* Улучшена логика автоопределения портов и протоколов при соединении с сервером из Svacer CLI<br />
<br />
=== Release 7-0-1 ===<br />
23.05.2023<br />
<br />
* Исправлена проблема с фильтрацией предупреждений для C# проектов<br />
<br />
=== Release 7-0-0 ===<br />
16.05.2023<br />
<br />
* Убрана зависимость от PostgreSQL из .deb и .rpm пакетов, чтобы проще было ставить Svacer только как клиент<br />
* Сделан пакет для Windows (.msi) и документация по установке и запуску на Windows<br />
* Теперь, если при svacer import и svacer sarif не указан путь к проекту, им считается текущая директория<br />
* Информация о разметке и блокировках теперь обновляется автоматически при изменении в другом браузере (табе) или другим пользователем<br />
* UI для пользовательских фильтров улучшен и перенесен в правую верхнюю часть экрана<br />
* UI для выбора проекта, ветки и снимка теперь находится на одном уровне<br />
* Улучшен UI для режима сравнения снимков<br />
* Добавлена возможность работать одновременно с несколькими открытыми файлами в режиме Code, это поведение можно изменить в настройках профиля пользователя<br />
* В левой навигационной панели детекторы теперь по умолчанию группируются по серьезности, это поведение можно изменить в настройках профиля пользователя<br />
* Профиль текущего пользователя теперь можно смотреть/редактировать только через меню в правом верхнем углу<br />
* Добавлена возможность копирования в системном логе и журнале<br />
* Для пользователя теперь запоминается последний контекст (проект/ветка/снимок), с которым он работал, он автоматически открывается при старте новой сессии<br />
* Групповая разметка теперь делается единой транзакцией, в случае ошибок или отмены все изменения откатываются<br />
* Добавлено предупреждение при использовании некорректных путей при использовании REST API с префиксом /api<br />
* Поддержка указания паролей из файла или pipe-а при использование Svacer CLI<br />
* Добавлена поддержка multi-tab code view для режима просмотра кода объекта сборки<br />
* Добавлена поддержка сохранения информации об удаленных детекторах при загрузке информации о детекторах из новой версии Svace<br />
* Исправлен импорт результатов анализа, если сборка проводилась с опцией --disable-dxr<br />
* Исправлены проблемы при импорте и прикреплении нескольких файлов к снимку<br />
* Исправлены ошибки с входом в систему пользователей LDAP (специальные символы в пароле, вход по атрибуту mail)<br />
* Добавлена возможность использования резервных серверов LDAP<br />
* Добавлена возможность автоматического назначения пользователям LDAP роли Svacer, в зависимости от принадлежности пользователя к LDAP группе<br />
* Добавлены новые public запросы на получение маркеров/снимков/проектов с учетом заданных параметров фильтрации<br />
* Добавлена поддержка TLS при работе сервера по протоколам HTTP и gRPC<br />
* Добавлена возможность загрузки статистики по общему количеству предупреждений и по количеству размеченных предупреждений для проектов и веток через REST API<br />
* Добавлена вкладка выбора проектов в расширении VSCode<br />
* Убрана возможность использовать всплывающее окно в VScode для добавления/редактирования/удаления комментариев, установки ревью-статусов, локов и т.д.<br />
<br />
=== Release 6-0-3 ===<br />
25.01.2023<br />
<br />
* RPM-пакет теперь при сборке упаковывается в gzip вместо zstd для обратной совместимости со старыми дистрибутивами<br />
* Если short url некорректен, то Svacer теперь будет возвращать корректный http error NotFound<br />
* Если путь к лог файлу явно не указан, то svacer.log будет создаваться во временной директории. Это решает проблемы при запуске Svacer из директорий с запретом на запись. Путь к лог файлу будет печататься в stdout<br />
* Лог файлы не будут создаваться, когда используется опция --help<br />
* Исправлены проблемы при миграции схемы данных, когда в PostgreSQL используется SSL подключение<br />
* Добавлены описания детекторов из последнего релиза Svace, которые были пропущены в релизе 6-0-2<br />
* Исправлена работа Svacer за proxy-сервером, где выставляется Header "X-Content-Type-Options nosniff"<br />
* Добавлены кнопки для скачивания системного лога и журнала из web-интерфейса<br />
* Поправлен ряд ошибок валидации схемы при экспорте в SARIF<br />
* Исправлено поведение при наличии нескольких хуков в конфигурационном файле<br />
* В информацию о маркере для хуков добавлены checker severity и reliability<br />
* Исправлен случайный порядок URL для маркеров при использовании public API для получения URL-ов<br />
* На главную страницу добавлена кнопка "Помощь", которая открывает документацию<br />
* При использовании команд навигации в режиме "Browse code" текущий файл теперь корректно подсвечивается в дереве файлов<br />
* В диалоге групповой разметки убран индикатор изменений в виде кружочка, наличие изменений можно определить по активности кнопок "Apply" и "Reset"<br />
* Кнопка обновления в верхнем меню теперь корректно обновляет информацию на странице Settings/Project<br />
* Различные небольшие исправления в пользовательском интерфейсе<br />
<br />
=== Release 6-0-2 ===<br />
16.12.2022<br />
<br />
* Исправлена проблема в UI с сохраненными пользовательскими фильтрами<br />
<br />
=== Release 6-0-1 === <br />
13.12.2022<br />
<br />
* Добавлено описание ряда детекторов, которые есть в последнем релизе Svace 3.3.2 но были пропущены в Svacer<br />
* Исправлено вылетание в Login Screen при удалении нотификации из панели нотификаций<br />
* Исправлено появление белого экрана при клике на детектор, информация о котором отсутствует<br />
* Ряд различных небольших исправлений в UI<br />
* Промежуточное хранилище будет очищаться по умолчанию при использовании команды import<br />
<br />
=== Release 6-0-0 === <br />
30.11.2022<br />
<br />
* Добавлено копирование комментариев при копировании разметки<br />
* Комментарии добавлены к отчету в формате csv<br />
* Добавлена возможность вводить пароль с клавиатуры для консольных команд<br />
* Добавлена возможность импортировать разметку из объекта сборки (из ранее загруженных данных)<br />
* Добавлена возможность импортировать разметку сразу после загрузки на сервер (опция для команды svacer upload)<br />
* Добавлена возможность загружать исходный код не из папки .svace-dir<br />
* Добавлена возможность бэкапа и восстановление объектного хранилища в сервер PostgresSQL<br />
* Добавлена возможность создания отчета по проекту в формате PDF через интерфейс командной строки и посредством REST API<br />
* Добавлена возможность подавления предупреждений через inline комментарии в коде<br />
* Добавлена возможность подавления предупреждений по идентификатору предупреждения через command line и REST API<br />
* Добавлена возможность ассоциировать организацию с пользователем и реестр организаций<br />
* Добавлена фильтрация списка комментариев по пользователю в правой панели веб-интерфейса<br />
* Добавлен поиск пользователей по его атрибутам в панели управления пользователями<br />
* Добавлена возможность заполнения данных профиля LDAP пользователя данными, полученными от LDAP сервера<br />
* Добавлена возможность прикреплять файлы к снимкам при импорте результатов (данные файлы составляют часть экспортируемых данных при экспорте снимков)<br />
* Добавлена возможность ассоциировать пользовательские атрибуты типа "строка" или массив строк со снимком при импорте данных (данные атрибуты составляют часть экспортируемых данных при экспорте снимков)<br />
* Добавлены command line операции по получению прикрепленных файлов и пользовательских атрибутов со снимков<br />
* Добавлена возможность группового добавления комментариев<br />
* Добавлена возможность указания сетевого интерфейса для работы WEB и GRPC серверов<br />
* Добавлен вывод краткой статистики по загруженному снимку при команде upload. Поддерживается текстовой и JSON форматы вывода<br />
* Существенно расширены возможности по интеграции Visual Studio Code с сервером Svacer<br />
* Добавлен флаг --git в команду import. При наличии такого флага, ищется ближайший git репозиторий содержащий .svace-dir и при наличии такого - используется путь к гит репозиторию для замены путей на префикс .build.<br />
* Portable PostgreSQL больше не входит в поставку. Вместо него поставляется docker-compose.yml файл для запуска PostgreSQL в докер-контейнере<br />
* Добавлено больше данных и информации об ошибках в вывод команды svacer import<br />
* Изменение Public API: добавлена точка входа /api/public/login<br />
* Операции по импорту и экспорту снимков доступны теперь обычным пользователям (не администраторам) при использовании command line интерфейса<br />
* Операция по экспорту снимков доступна обычному пользователю из веб-интерфейса (импорт все еще требует роль администратора для веб-интерфейса)<br />
* Операции по экспорту снимков переведены на асинхронный режим. Нотификация о готовности будет показана пользователю и доступна в панели нотификаций<br />
* Обновлено описание детекторов в соответствии с релизом Svace 3.3.2<br />
* Исправлена ошибка обработки корневых сертификатов при подключении к LDAP серверу по протоколу ldaps<br />
* Исправлено ошибочное создание дубликатов локальных учетных записей LDAP пользователей (case sensitive login)<br />
* Различные исправления в пользовательском интерфейсе с целью оптимизации производительности<br />
* Добавлены пропущенные проверки ролей при работе с веб-интерфейсом<br />
* Svacer больше не создает временные файлы в директории с исполняемым файлом<br />
* Устаранены задержки при удалении веток и проектов</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:Import_from_Svace&diff=3459Help:Import from Svace2026-01-30T14:53:52Z<p>Gribunin: baseline-check</p>
<hr />
<div>== CLI команды ==<br />
svacer import --svace <path-to-svace><br />
svacer upload<br />
<br />
Эти две команды импортируют результаты анализа из '''.svace-dir''' в текущей директории и загрузят их на сервер Svacer по адресу '''localhost:8080'''.<br />
<br />
== Процесс импорта ==<br />
Процесс импорта результатов работы статического анализатора Svace состоит из двух шагов:<br />
# Дедупликация данных, предобработка, конвертирование во внутренний формат и сохранение результатов в промежуточном хранилище (svacer import).<br />
# Загрузка данных из промежуточного хранилища на сервер (svacer upload).<br />
<br />
Можно импортировать результаты и из других статических анализаторов, поддерживающих [[Help:Sarif#Загрузка на сервер из SARIF|формат SARIF]].<br />
<br />
=== Промежуточное хранилище ===<br />
Промежуточное хранилище используется для хранения результатов, подготовленных для загрузки на сервер. При импорте данных в промежуточное хранилище снимкам назначается уникальный ID, задается имя проекта и ветки. <br />
Промежуточное хранилище можно использовать для аккумулирования результатов нескольких запусков анализатора, в том числе для различных проектов. <br />
По умолчанию, промежуточное хранилище создается в директории '''.svacer-dir''' рядом с директорией '''.svace-dir.'''<br />
Параллельный доступ к хранилищу из разных экземпляров Svacer '''не допускается'''. Если необходимо использовать разделяемое хранилище и конкурентный доступ, Svacer следует запускать в режиме удаленного промежуточного хранилища.<br />
Процедура импорта c промежуточным хранилищем по умолчанию (размещается в '''<path to project>/.svacer-dir'''):<br />
<br />
svacer import --svace <path to svace> [path to project]<br />
<br />
где '''<path to svace>''' — путь к исполняемому файлу svace из дистрибутива svace, '''[path to project]''' — путь к проекту (директории, содержащей .svace-dir). Его можно не указывать, тогда в качестве пути к проекту будет использована текущая директория.<br />
<br />
Процедура импорта с явным указанием размещения промежуточного хранилища:<br />
<br />
svacer import --store <path to store> --svace <path to svace> <path to project><br />
<br />
=== Пользовательские атрибуты ===<br />
При импорте данных можно ассоциировать пользовательские строковые атрибуты со снимком. Значения атрибутов доступно посредством публичного REST API и интерфейса командной строки. Это позволяет связать дополнительные данные с результатами (например commit ID). Пользовательские атрибуты нельзя модифицировать после импорта данных на сервер.<br />
Пользовательские атрибуты экспортируются и импортируются как часть информации при использовании функциональности по экспорту и импорту снимков.<br />
<br />
Пользовательский атрибут может быть передан при использовании команды import посредством опции '''--field <name>:<value>'''. Опция может быть указана несколько раз в командной строке.<br />
<br />
svacer import ... --field f1:val1 --field f2:val2 ...<br />
<br />
Если одно и тоже поле указано несколько раз, то значения поля сохраняются как JSON массив строк. <br />
'''Допустимое имя''' пользовательского атрибута состоит из латинских букв, цифр, знаков подчеркивание или минуса.<br />
<br />
Для получения списка всех пользовательских атрибутов в JSON виде используется следующая команда в командной строке<br />
<br />
'''svacer access''' --project <project name> --branch <branch name> --snapshot <name or id> --user <user name> --password <password> '''custom_fields'''<br />
<br />
Результат операции выдается как JSON объект в stdout. Объект имеет следующую структуру<br />
{<br />
"field name1":"value",<br />
"field name2": ["value", "value"..]<br />
} <br />
Для получения значения конкретного пользовательского атрибута используется следующая команда<br />
<br />
'''svacer access''' --project <project name> --branch <branch name> --snapshot <name or id> --user <user name> --password <password> '''custom_fields --get <field name>'''<br />
<br />
Значение атрибута выводится в stdout как JSON строка или массив.<br />
=== Клонирование ветки ===<br />
При импорте данных возможно клонирование ветки (вместе со снимками, разметкой и комментариями) из того же проекта, куда происходит импорт данных.<br />
<br />
Для клонирования ветки следует использовать опцию '''--if-no-branch <value>'''<br />
<br />
svacer import ... --if-no-branch <value> ...<br />
<br />
Значения, которые может принимать опция '''--if-no-branch''':<br />
<br />
* '''clone-{name|id}''' — клонировать ветку с заданным именем|id (по умолчанию clone-master)<br />
* '''create-empty''' — создает пустую ветку<br />
* '''return-error''' — возвращает ошибку, если для опции '''--branch <branch_name>''' не существует ветки с именем branch_name<br />
<br />
{{Note}} Если не указать данную опцию, то будет автоматически клонироваться ветка master, поэтому для избежания ошибок следует убедиться, что ветка master существует, если данная опция не указана, иначе будет выведена ошибка.<br />
<br />
==== Клонирование разметки и комментариев ====<br />
При импорте данных возможно клонирование разметки и комментариев ветки из того же проекта, куда происходит импорт данных.<br />
<br />
Для клонирования разметки и комментариев следует использовать опцию '''--clone-review {name|id}'''<br />
<br />
svacer import ... --clone-review {name|id} ...<br />
<br />
Данная опция принимает имя или id ветки, из которой необходимо склонировать разметку и комментарии.<br />
<br />
Приоритет опции '''--clone-review''' выше, чем у опции '''--if-no-branch''', поэтому возможно клонировать снимки из одной ветки, а разметку и комментарии из другой.<br />
<br />
Если ветка с таким именем или id не будет найдена, то при загрузке данных ('''svacer upload ...''', либо '''svacer import --upload ...''') загрузка произойдет, но без склонированной разметки.<br />
<br />
=== Прикрепление файлов ===<br />
При импорте данных возможно прикрепление файлов размером до 300Мб к снимку. Файлы будут доступны пользователю в веб-интерфейсе и посредством интерфейса командной строки. Прикрепленные файлы фиксируются в момент операции импорта и не могут быть модифицированы после загрузки на сервер. Удалить файлы может администратор посредством веб интерфейса. Основное назначение данной функциональности прикрепление некоторой иммутабельной информации к результатам анализа для использования в интеграциях со сторонними системами.<br />
Прикрепленные файлы являются частью данных, которые экспортируются и импортируются посредством функциональности экспорта и импорта снимков.<br />
<br />
Для прикрепления файлов следует использовать опцию '''--attach <file name>'''<br />
<br />
svacer import ... --attach file1.txt --attach file2.txt ...<br />
<br />
Опция может быть указана несколько раз. После загрузки данных на сервер файлы будут видимы в панели информации о снимке<br />
<br />
[[File:SnapshotInfo.png|none|alt=Snapshot Info Window]]<br />
<br />
Для получения списка файлов из командной строки следует использовать команду<br />
<br />
'''svacer access''' --project <project name> --branch <branch name> --snapshot <name or id> --user <user name> --password <password> '''attachments''' --list<br />
<br />
Результат работы команды представляет собой JSON массив объектов вида<br />
<br />
[{<br />
"id": 11,<br />
"snapshot_id": "d99c23f7-9fb9-4f4e-85ac-2539328947e0",<br />
"lid": 122885,<br />
"short_name": "Makefile",<br />
"description": "/home/ruseer/static-analysis/svacer/Makefile",<br />
"created_by": "importer",<br />
"updated_by": null,<br />
"create_ts": "2022-10-18T06:41:54.532925Z",<br />
"update_ts": null,<br />
"checksum": "9b1e02a276e810829ac2e38fb775c4ff8d269d0f44fd0fbae40f79a0320389ad"<br />
}]<br />
<br />
Для получения содержимого файла из командной строки следует использовать команду<br />
<br />
'''svacer access''' --project <project name> --branch <branch name> --snapshot <name or id> --user <user name> --password <password> '''attachments''' --get <id> <output file><br />
<br />
* Если '''<output file>''' не указан, то результат будет напечатан в stdout;<br />
* Если '''<branch>''' не указан, то будет использован ветка master;<br />
* Если '''<snapshot>''' не указан, то будет использован последний снимок на указанной ветке.<br />
<br />
=== Загрузка данных на сервер ===<br />
{{Note|type=warn|text=При загрузке данных на сервер, а также при прочих взаимодействиях клиента Svacer с сервером Svacer, крайне рекомендуется, чтобы версия клиента совпадала с версией сервера. В случае несовпадения версий возможны непредсказуемые ошибки.}}<br />
<br />
Для загрузки данных из промежуточного хранилища на сервер используется команда '''upload''':<br />
<br />
svacer upload --user <user> --password <pwd> --host <host> --port <rest_port> --grpc <grpc_port> <path_to_store><br />
<br />
Если отсутствуют параметры:<br />
* '''--user''' и '''--password''', то используется специальный системный пользователь '''importer''' — он предназначен для импорта данных на сервер;<br />
* '''--host''', то используется '''locahost''';<br />
* '''--port''' и '''--grpc''', то используются их значения по умолчанию;<br />
При загрузке данных на сервер уже загруженные снимки повторно не загружаются. Разделяемая информация (такая как исходные файлы, где один и тот же файл может использоваться в различных анализах и т.п.) также повторно не загружается. <br />
При сбоях в ходе загрузки проводится повторная загрузка, но при этом загружаются только недостающие данные.<br />
<br />
В случае если Svacer запущен с поддержкой SSL/TLS или работает за reverse proxy и доступен по протоколу HTTPS, то для загрузки требуется явно указать протокол в параметре '''--host''', либо добавить опцию '''--ssl'''.<br />
<br />
svacer upload --host https://<url_without_port> <path_to_store><br />
svacer upload --ssl --host <url_without_port> <path_to_store><br />
<br />
При этом grpc порт (по умолчанию — 3002), по которому идет загрузка данных, на сервере должен быть доступен.<br />
<br />
Для информации о загрузке данных на сервер с авторизацией в LDAP см. [[LDAP configuration#Использование CLI сервера Svacer с поддержкой LDAP|Использование CLI Svacer с поддержкой LDAP]].<br />
<br />
При загрузке данных на сервер можно включить печать краткой статистики по загруженным результатам. Данная статистика включает информацию о новых и пропущенных предупреждениях, по сравнению с последним ранее загруженным снимком. Выдача краткой статистики возможно в текстовом или JSON виде. Результаты печатаются в stdout.<br />
<br />
{{Note|text=Для корректной работы опций <code>--quality-gate</code> и <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:<br />
underscores_in_headers on;<br />
См. [[Help:Configuration#Nginx|пример конфига]]}}<br />
<br />
svacer upload ... --quick-stats --out-format text ...<br />
<br />
Пример вывода<br />
Quick Stats:<br />
Previous snapshot : Snapshot 2022-11-16 10:11:37 +0300<br />
Current snapshot : Snapshot 2022-11-16 10:23:08 +0300<br />
New : 1<br />
Missing : 0<br />
Matched : 1<br />
Same : 0<br />
<br />
svacer upload ... --quick-stats --out-format json ...<br />
<br />
Пример вывода<br />
{"branch":"391f21d1-2173-449c-9d1a-dd846d2a6471","snapshot":"34a1125d-86a3-45d3-9b41-cb5da24ab96e","snapshotName":"Snapshot 2022-11-21 10:19:06 +0300","lastSnapshot":"59657ae8-c3b6-48bc-b586-a6c0580cdb50","lastSnapshotName":"Snapshot 2022-11-21 10:18:09 +0300","same":2}<br />
<br />
Формат JSON определяется protobuf3 схемой (ряд полей носит внутренний характер):<br />
message ImportSummaryContext {<br />
string branch = 1;<br />
string snapshot = 2;<br />
string snapshotName = 9;<br />
string lastSnapshot = 3; <br />
string lastSnapshotName = 4; <br />
int64 new = 5;<br />
int64 missing = 6;<br />
int64 matched = 7;<br />
int64 same = 8;<br />
string qualityGate = 10;<br />
string baseline_branch_name = 11;<br />
string baseline_project_name = 12;<br />
string branch_name = 13;<br />
string project_name = 14;<br />
string project_id = 15; <br />
string baseline_snapshot_id = 16;<br />
string baseline_branch_id = 19;<br />
string baseline_project_id = 20;<br />
string baseline_snapshot_name = 21;<br />
}<br />
<br />
По умолчанию, если опция по указанию формата выдачи отсутствует, выдача идет в текстовом режиме.<br />
<br />
=== Переименование снимка после импорта ===<br />
<br />
При необходимости, имя загруженного снимка можно изменить. Данная опция поддерживается только для пользователей с правами администратора сервера.<br />
<br />
svacer container snapshot rename --host <host> --port <port> --user <user name> --password <pwd> --id <snapshot id> --name <snapshot name><br />
<br />
Идентификатор снимка можно посмотреть в веб-интерфейсе или получить посредством public API.<br />
<br />
=== Модификация путей в разметке при импорте ===<br />
<br />
==== Обычное поведение ====<br />
По умолчанию пути к файлам не меняются, за исключением пути к папки '''.svace-dir''', он будет заменён на '''.build'''. Эту информацию можно увидеть при импорте проекта:<br />
<br />
svacer import --clean .svacer-dir<br />
...<br />
info The path prefix of .svace-dir 'C:\work\generate_files\gen_exp' will be trimmed when converting file paths<br />
...<br />
<br />
После этого все маркеры из этой папки и дочерних будут в '''Review''' показывать путь вида '''/.build/test500_1.c''' вместо полного пути для файла '''C:\work\generate_files\gen_exp\test500_1.c'''.<br />
<br />
[[File:SimpleSourceCode.png|none|alt=Simple Source Code Window]]<br />
<br />
==== Использование --path-prefix ====<br />
При необходимости модификацию по умолчанию можно заменить через '''--path-prefix'''.<br />
Значения опции передаются в виде:<br />
<br />
--path-prefix "prefix_for_replace1:value1;prefix_for_replace2:value2; ..."<br />
<br />
Поддерживается как передача данных сразу в опцию, так и через указание файла содержащего значения. Разумно делать замены для унификации вида проекта, собранного на разных машинах (или из разных папок). При использовании файла допустимо размещать каждую замену на отдельную строчку.<br />
<br />
Префиксы путей заменяются только при полном совпадении (включая регистр, даже на Windows).<br />
Для указания двоеточия в префиксе пути используется удвоенное двоеточие, к примеру (для показа преобразований добавлено '''--debug'''):<br />
<br />
svacer --debug import --clean --upload --path-prefix "C::\work:work" .svacer-dir<br />
...<br />
INFO Creating regular object store<br />
DEBUG Creating path mapping rule 'C:\work' => 'work'<br />
DEBUG Creating path mapping rule 'C:/work' => 'work'<br />
DEBUG Creating path mapping rule '/C_/work' => 'work'<br />
...<br />
<br />
После импорта на сервере можно увидеть файл: '''/work/generate_files/gen_exp/test500_1.c'''<br />
<br />
[[File:PathPrefixSourceCode.png|none|alt=PathPrefixSourceCode]]<br />
<br />
==== Использование --build-object @auto ====<br />
При импорте конкретного файла *.svres исходный код может быть загружен, при указании опции '''--build-object @auto'''. В случае, если этот файл лежит в папке .svace-dir, исходный код будет взят из нее. При отсутствии папки .svace-dir файлы будут браться по абсолютным путям из файла *.svres.<br />
Для указания конкретных директорий поиска подходящих файлов из *.svres следует использовать опцию '''--source-tree''', которую можно указать несколько раз, чтобы задать несколько корневых директорий. Поиск в этих директориях будет происходить только в случае, когда по путям из файла *.svres были найдены не все файлы. В случае успешного сопоставления, на сервер будут загружены соответствующие файлы из директории source tree.<br />
<br />
==== Использование --full-paths ====<br />
Допустимо также полное отключение модификаций путей, для этого импорт надо производить с опцией '''--full-paths'''. Опция блокирует как модификацию по умолчанию '''.build''', так и явные указания через '''--path-prefix'''.<br />
<br />
svacer --debug import --clean --upload --full-paths .svacer-dir<br />
<br />
После загрузки на сервере будет виден только полный путь: '''/C_/work/generate_files/gen_exp/test500_1.c'''.<br />
<br />
[[File:FullPathsSourceCode.png|none|alt=FullPathsSourceCode window]]<br />
<br />
Пути из Windows преобразуются в стиль Linux с небольшим преобразованием символов.<br />
<br />
=== Использование quality gate ===<br />
<br />
Возможна проверка новых, пропущенных, одинаковых, измененных предупреждений, для этого надо производить импорт с опцией '''--quality-gate'''.<br />
<br />
--quality-gate value Specify a quality gate. Format: stat_1:severity_1:N_1:[statuses_1],...,stat_k:severity_k:N_k:[statuses_k], stat takes values: new, missing, matched, same, total; severity takes the following values: all, critical, major, normal, minor, undefined, <detector name part>; N is a natural number; statuses - an optional field, specified in square brackets with a separator ";" possible values - confirmed, false_positive, wont_fix, unclear, undecided, when specifying statuses, the quality gate will be searched only for markers that have exactly these statuses, for example [confirmed;wont_fix;undecided]. If the severity of the number N is exceeded, it will out a warning. Also, as a value, you can specify a json or yaml file in which the quality gate is specified.<br />
<br />
Флаг принимает на вход тип предупреждений (stat), severity, их количество (N) и их статусы (statuses).<br />
<br />
* stat задает тип предупреждений. Возможные значения:<br />
** '''new''' — присутствует в новом снимке, но отсутствует в старом<br />
** '''missing''' — присутствует в старом снимке, но отсутствует в новом<br />
** '''matched''' — присутствуют изменения в файлах, не повлиявшие на выданное предупреждение<br />
** '''same''' — одинаковые<br />
** '''total''' — сумма всех вышеперечисленных (то есть количество предупреждений в объединении старого и нового снимков)<br />
* severity задается либо непосредственным его указанием ('''critical''', '''major''', '''normal''', '''minor''', '''undefined'''), либо '''all''' (все severity), либо частью имени детектора в формате [https://www.postgresql.org/docs/current/functions-matching.html postgres ILIKE]<br />
* N — порог, после которого вызывается срабатывание. Не включает данное число (т. е. если указать 5, то при нахождении 6 и более вызывается срабатывание quality-gate)<br />
* statuses — '''опциональное''' поле, в котором можно указать какие статусы (разметку) учитывать при нахождении предупреждений. Возможные значения '''confirmed''', '''false_positive''', '''wont_fix''', '''unclear''', '''undecided'''. Задаются в квадратных скобках с разделителем <code>;</code>. Например <code>[confirmed;wont_fix]</code>. Если не указать данное поле, то будут учитываться все статусы. При указании в command line рекомендуется значение опции <code>--quality-gate</code> экранировать в двойные кавычки.<br />Принципы учета статусов:<br />
** Если предупреждение размечено в новом снимке (значение не '''undecided'''), разметка берется из нового предупреждения<br />
** Если в новом снимке нет разметки у данного предупреждения, а в старом есть, то берется разметка из старого предупреждения<br />
** В остальных случаях у данного предупреждения разметка равна '''undecided'''.<br />
<br />
Пример:<br />
--quality-gate "total:critical:0:[confirmed;wont_fix],new:all:10"<br />
<br />
Тогда опция сработает, если либо:<br />
<br />
# Cтатическим анализатором будут найдены общее количество предупреждений (новых, пропущенных, одинаковых, измененных) с '''severity:critical''' и статусами '''confirmed''' и '''won't fix'''<br />
# Cтатическим анализатором будут найдены новые предупреждения с любым статусом и severity<br />
<br />
Пример вывода:<br />
Quality gate exceed:<br />
Previous snapshot : Snapshot 2025-06-16 15:37:09 +0300<br />
Current snapshot : Snapshot 2025-06-16 15:37:39 +0300<br />
Stat : total<br />
Severity : Critical<br />
Severity Statuses : confirmed wont_fix<br />
Severity Threshold : 0<br />
Found Severity : 3<br />
<br />
Также quality-gate можно задать файлом в формате json или yaml (не yml).<br />
<br />
Пример json файла:<br />
<br />
<code>["total:all:1", "total:proc:1"]</code><br />
<br />
Пример yaml файла:<br />
- "total:all:1"<br />
- "total:proc:1"<br />
<br />
{{Note|text=Для корректной работы опций <code>--quality-gate</code> и <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:<br />
underscores_in_headers on;<br />
См. [[Help:Configuration#Nginx|пример конфига]]}}<br />
<br />
==== Флаг --quality-gate-exit-code ====<br />
В случае срабатывания quality gate можно указать какой exit code от 0 до 125 будет возвращен. <br />
<br />
--quality-gate-exit-code value Specify the exit code of the application in the range from 0 to 125, which will be issued when the quality-gate is exceeded. The default is 0.<br />
<br />
{{Note|text=Значение по умолчанию 0, поэтому без явного задания exit code срабатывание quality-gate не вернет ненулевой статус и при использовании в CI/CD pipeline не будет помечен как failed. Так сделано для упрощения внедрения quality-gate опции в существующий CI/CD. Вначале можно проанализировать логи и если данные корректны, добавить опцию <code>--quality-gate-exit-code</code> с ненулевым значением.}}<br />
<br />
==== Флаг --quality-gate-verbose ====<br />
Если необходимо выводить информацию и об успешно прошедших quality gate, то нужно добавить флаг <code>--quality-gate-verbose</code><br />
<br />
Пример вывода:<br />
Quality gate exceed:<br />
Previous snapshot : Snapshot 2025-06-16 15:37:39 +0300<br />
Current snapshot : Snapshot 2025-06-16 16:10:33 +0300<br />
Stat : total<br />
Severity : Critical<br />
Severity Statuses : confirmed wont_fix<br />
Severity Threshold : 0<br />
Found Severity : 3<br />
The result of comparison of those who have completed quality gate:<br />
Previous snapshot : Snapshot 2025-06-16 15:37:39 +0300<br />
Current snapshot : Snapshot 2025-06-16 16:10:33 +0300<br />
Stat : new<br />
Severity : All<br />
Severity Threshold : 10<br />
Found Severity : 0<br />
<br />
==== Флаг --baseline ====<br />
Если сравнение необходимо проводить не с предыдущим снимком в этой же ветке, то можно указать флаг <code>--baseline</code> (также работает для флага <code>--quick-stats</code>).<br />
<br />
--baseline value A snapshot to compare (--quality-gate and/or --quick-stats). Format: {project}:::{branch}:::{snapshot} or {project}:::{branch} or {project} use UUID or name. By default, snapshot is the last added, branch is master. If the flag is not specified, then the comparison will be with the latest snapshot from the branch where the snapshot is loaded.<br />
<br />
Указывается в формате <code>{project}:::{branch}:::{snapshot}</code> или <code>{project}:::{branch}</code> или <code>{project}</code>, используя имена или UUID. По умолчанию используется ветка master (если указан только проект) и последний добавленный снимок (если снимок не указан).<br />
<br />
При указании данного флага меняется вывод:<br />
<br />
* В текстовом формате добавляются строки об имени проекта, ветки и снимка, с которым сравнивался загружаемый снимок<br />
* В json формате добавляются имена и id проекта, ветки и снимка, с которым сравнивался загружаемый снимок<br />
<br />
Если baseline не может быть точно определен (ошибка в имени проекта, ветки и т. п.), то импорт не производится и выдается ошибка.<br />
<br />
==== Флаг --baseline-check ====<br />
Для вывода quick-stats и quality-gate даже в случае отсутствия снимка, ветки или проекта используйте опцию <code>--baseline-check</code>.<br />
<br />
Данный флаг принимает следующие параметры:<br />
<br />
* пустой или 'project,branch,snapshot' (требует проект, ветку и снимок, по умолчанию)<br />
* 'skip' (разрешает отсутствие проекта, ветки, снимка)<br />
* 'project' (требует проект, разрешает отсутствие ветки и снимка)<br />
* 'project,branch' (требует проект и ветку, разрешает отсутствие снимка)<br />
<br />
Можно использовать полные названия с запятыми или сокращения без запятых: 'p' для project, 'b' для branch, 's' для snapshot, например 'pbs'. Всегда пытается найти снимок; если он не найден, то использует пустой baseline (и все предупреждения помечаются как New). Ошибка возвращается только если не выполнен обязательный уровень.<br />
<br />
==== Флаг --out-file ====<br />
<br />
Для указания файла, в который необходимо вывести результаты quality gate, используйте опцию <code>--out-file</code> (по умолчанию вывод идет в stdout).<br />
<br />
==== Флаг --out-format ====<br />
<br />
Для указания в каком формате вывести результаты quality gate используйте опцию <code>--out-format</code>. Принимает значения text (человекочитаемый) и json. По умолчанию text.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3445Help:CLI/cleanup2025-12-16T09:53:43Z<p>Gribunin: cleanup change description</p>
<hr />
<div>= Автоматическое удаление снимков =<br />
<br />
== Обзор ==<br />
<br />
Удаление происходит по умолчанию раз в 24 часа (время можно задать при запуске сервера опцией <code>--snapshots-cleanup-period</code>, либо в конфигурационном файле опцией <code>snapshots-cleanup-period</code>, либо переменной окружения <code>SVACER_CLEANUP_SNAPSHOTS_PERIOD</code>, но не меньше 15 минут). Первое удаление всех подходящих снимков будет выполнено через указанное время после запуска сервера.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление самых старых по времени создания подходящих снимков и заносится отметка в таблицу удаленных снимков и в системный журнал. После этого происходит удаление пустых веток и проектов в соответствии с правилами удаления. Также информация об удалении через cleanup вносится в системный журнал.<br />
<br />
Данная функциональность доступна пользователям с доступом '''ServerOperations'''.<br />
<br />
== Добавление нового правила удаления ==<br />
<br />
svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --keep-time <nowiki><time></nowiki> --min-snapshots <min> --cleanup-type <type><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех проектов)<br />
* <code>--branch</code> — ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--keep-time</code> — время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней).<br />
* <code>--min-snapshots</code> — количество снимков, которое необходимо оставлять в ветке, подходящей под паттерн project + branch. По умолчанию 0<br />
* <code>--cleanup-type</code> — тип очистки. Возможные значения - project, branch, snapshot (по умолчанию snapshot). При указании snapshot будут очищаться снимки в соответствии с паттерном проект+ветка+снимок и проверяться <code>keep-time</code> и <code>min-snapshots</code>. При указании branch будут удаляться пустые ветки в соответствии с паттерном project + branch. При указании project Будут удаляться пустые проекты (у которых нет веток) в соответствии с паттерном project. При указании branch или project невозможно указать <code>keep-time</code> и <code>min-snapshots</code>, эти флаги не учитываются.<br />
<br />
=== Шаблоны и паттерны ===<br />
<br />
Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:<br />
<br />
'''1. Имя или ID:'''<br />
--project "MyProject"<br />
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта<br />
<br />
'''2. <code>*</code> (любое количество любых символов):'''<br />
--project "Dev*" # DevProject, Development<br />
--branch "*test*" # test, my-test, testing<br />
--snapshot "nightly-*"<br />
<br />
'''3. Регулярные выражения (с префиксом <code>re:</code>):'''<br />
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5<br />
--branch "re:^feature/[0-9]+$" # feature/123<br />
<br />
== Добавление запрета на удаление ==<br />
<br />
svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех проектов)<br />
<br />
* <code>--branch</code> — ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.<br />
<br />
== Удаление правила ==<br />
<br />
svacer server cleanup delete --user <user> --password <password> --id <config id><br />
<br />
Где:<br />
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)<br />
<br />
== Вывести таблицу ==<br />
<br />
svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json><br />
<br />
Где:<br />
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков<br />
<br />
* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат<br />
== Запуск очистки вручную ==<br />
<br />
svacer server cleanup run --user <user> --password <password><br />
<br />
Запускает процесс очистки немедленно (вне расписания).<br />
<br />
== Примеры ==<br />
<br />
=== Добавление нового правила ===<br />
<br />
'''Удаление по времени'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --keep-time "240h"<br />
<br />
Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".<br />
<br />
'''Ограничение количества'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 20<br />
<br />
В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.<br />
<br />
'''Очистка пустых веток'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "master" --cleanup-type branch<br />
<br />
В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*"<br />
<br />
Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются правилами cleanup'''.<br />
<br />
=== Вывод таблицы правил ===<br />
<br />
svacer server cleanup list --user admin --password admin --type rule<br />
[[File:Cleanup rules.png|none|thumb|955x955px]]<br />
<br />
=== Вывод таблицы запретов ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule<br />
[[File:Cleanup exclude rule table.png|none|thumb|1009x1009px]]<br />
<br />
=== Вывод в JSON формате ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule --format json<br />
<br />
Вывод:<br />
<br />
[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]<br />
<br />
=== Удаление правила ===<br />
<br />
svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416<br />
<br />
=== Использование regex ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --keep-time 168h<br />
<br />
Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code><br>Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code><br />
<br />
=== Regex синтаксис ===<br />
<br />
{| class="wikitable"<br />
! Паттерн !! Описание !! Пример<br />
|-<br />
| <code>^</code> || Начало строки || <code>^test</code><br />
|-<br />
| <code>[^x]</code> || Отрицание символов || <code>^[^m].*$</code><br />
|-<br />
| <code>$</code> || Конец строки || <code>test$</code><br />
|-<br />
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c<br />
|-<br />
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123<br />
|-<br />
| <code>.+</code> || Один или более || <code>test.+</code> → test-1<br />
|-<br />
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9<br />
|-<br />
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc<br />
|-<br />
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC<br />
|-<br />
| <code>(a&#124;b)</code> || "a" или "b" || <code>(test&#124;prod)</code><br />
|-<br />
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code><br />
|}<br />
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.<br />
<br />
Для правил отрицания конкретного элемента возможно использовать сложные правила, например:<br />
<br />
<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code><br />
<br />
Данное правило выбирает все ветки, кроме <code>main</code>.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3444Help:CLI/cleanup2025-12-16T09:36:25Z<p>Gribunin: cleanup remove min-snapshots for exclude-rule</p>
<hr />
<div>= Автоматическое удаление снимков =<br />
<br />
== Обзор ==<br />
<br />
Удаление происходит по умолчанию раз в 24 часа (время можно задать при запуске сервера опцией <code>--snapshots-cleanup-period</code>, либо в конфигурационном файле, либо переменной окружения <code>SVACER_CLEANUP_SNAPSHOTS_PERIOD</code>, но не меньше 15 минут). Первое удаление всех подходящих снимков будет выполнено через указанное время после запуска сервера.<br />
<br />
Применять может только пользователь с доступом '''ServerOperations'''.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление самых старых по времени создания подходящих снимков и заносится отметка в таблицу удаленных снимков и в системный журнал. После этого происходит удаление пустых веток и проектов в соответствии с правилами удаления. Также информация об удалении через cleanup вносится в системный журнал.<br />
<br />
== Добавление нового правила удаления ==<br />
<br />
svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --keep-time <nowiki><time></nowiki> --min-snapshots <min> --cleanup-type <type><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех проектов)<br />
* <code>--branch</code> — ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--keep-time</code> — время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней).<br />
* <code>--min-snapshots</code> — количество снимков, которое необходимо оставлять в ветке, подходящей под паттерн project + branch. По умолчанию 0<br />
* <code>--cleanup-type</code> — тип очистки. Возможные значения - project, branch, snapshot (по умолчанию snapshot). При указании snapshot будут очищаться снимки в соответствии с паттерном проект+ветка+снимок и проверяться <code>keep-time</code> и <code>min-snapshots</code>. При указании branch будут удаляться пустые ветки в соответствии с паттерном project + branch. При указании project Будут удаляться пустые проекты (у которых нет веток) в соответствии с паттерном project. При указании branch или project невозможно указать <code>keep-time</code> и <code>min-snapshots</code>, эти флаги не учитываются.<br />
<br />
=== Шаблоны и паттерны ===<br />
<br />
Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:<br />
<br />
'''1. Имя или ID:'''<br />
--project "MyProject"<br />
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта<br />
<br />
'''2. <code>*</code> (любое количество любых символов):'''<br />
--project "Dev*" # DevProject, Development<br />
--branch "*test*" # test, my-test, testing<br />
--snapshot "nightly-*"<br />
<br />
'''3. Регулярные выражения (с префиксом <code>re:</code>):'''<br />
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5<br />
--branch "re:^feature/[0-9]+$" # feature/123<br />
<br />
== Добавление запрета на удаление ==<br />
<br />
svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех проектов)<br />
<br />
* <code>--branch</code> — ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.<br />
<br />
== Удаление правила ==<br />
<br />
svacer server cleanup delete --user <user> --password <password> --id <config id><br />
<br />
Где:<br />
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)<br />
<br />
== Вывести таблицу ==<br />
<br />
svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json><br />
<br />
Где:<br />
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков<br />
<br />
* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат<br />
== Запуск очистки вручную ==<br />
<br />
svacer server cleanup run --user <user> --password <password><br />
<br />
Запускает процесс очистки немедленно (вне расписания).<br />
<br />
== Примеры ==<br />
<br />
=== Добавление нового правила ===<br />
<br />
'''Удаление по времени'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --keep-time "240h"<br />
<br />
Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".<br />
<br />
'''Ограничение количества'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 20<br />
<br />
В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.<br />
<br />
'''Очистка пустых веток'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "master" --cleanup-type branch<br />
<br />
В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*"<br />
<br />
Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются правилами cleanup'''.<br />
<br />
=== Вывод таблицы правил ===<br />
<br />
svacer server cleanup list --user admin --password admin --type rule<br />
[[File:Cleanup rules.png|none|thumb|955x955px]]<br />
<br />
=== Вывод таблицы запретов ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule<br />
[[File:Cleanup exclude rule table.png|none|thumb|1009x1009px]]<br />
<br />
=== Вывод в JSON формате ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule --format json<br />
<br />
Вывод:<br />
<br />
[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]<br />
<br />
=== Удаление правила ===<br />
<br />
svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416<br />
<br />
=== Использование regex ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --keep-time 168h<br />
<br />
Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code><br>Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code><br />
<br />
=== Regex синтаксис ===<br />
<br />
{| class="wikitable"<br />
! Паттерн !! Описание !! Пример<br />
|-<br />
| <code>^</code> || Начало строки || <code>^test</code><br />
|-<br />
| <code>[^x]</code> || Отрицание символов || <code>^[^m].*$</code><br />
|-<br />
| <code>$</code> || Конец строки || <code>test$</code><br />
|-<br />
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c<br />
|-<br />
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123<br />
|-<br />
| <code>.+</code> || Один или более || <code>test.+</code> → test-1<br />
|-<br />
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9<br />
|-<br />
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc<br />
|-<br />
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC<br />
|-<br />
| <code>(a&#124;b)</code> || "a" или "b" || <code>(test&#124;prod)</code><br />
|-<br />
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code><br />
|}<br />
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.<br />
<br />
Для правил отрицания конкретного элемента возможно использовать сложные правила, например:<br />
<br />
<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code><br />
<br />
Данное правило выбирает все ветки, кроме <code>main</code>.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Edit_markers_(command_line)&diff=3355Edit markers (command line)2025-11-19T09:05:36Z<p>Gribunin: edit-markers change descriptions to more correct description</p>
<hr />
<div>== Обзор ==<br />
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:<br />
<br />
* '''skip''' — пропуск (удаление) маркеров, соответствующих условию<br />
* '''change''' — изменение полей маркеров<br />
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяются уникальные трассы и остается только один маркер с наименьшим порядковым номером предупреждения (local_id) в файле результатов анализа. Остальные маркеры удаляются.<br />
Все операции происходят на стороне клиента до загрузки данных на сервер. При импорте результатов Svace, а также sarif (без указания флага --upload) изменяется .svacer-dir. Директория .svace-dir остается неизменной. Снимок остается неизменным при импорте. <br />
<br />
Данный функционал работает со снимками, созданными Svacer версии 7-0-0 и новее. Если у вас более старый снимок, то импортируйте и экспортируйте его для возможности работы с edit-markers.<br />
<br />
== Использование ==<br />
<br />
=== Импорт результатов Svace ===<br />
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code><br />
<br />
Применяет правила редактирования к маркерам при импорте результатов анализа Svace.<br />
<br />
=== Импорт SARIF ===<br />
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при импорте SARIF-файлов.<br />
<br />
=== Импорт снимка с редактированием ===<br />
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила к снимку при импорте. Дополнительно можно сохранить отредактированный снимок:<br />
<br />
<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code><br />
<br />
== Формат файла правил ==<br />
Правила задаются в виде JSON-файла, содержащего массив объектов правил:<br />
[<br />
{<br />
"action": "тип_действия",<br />
"rules": "условие_или_список_полей",<br />
"change": { /* только для action: "change" */ }<br />
},<br />
...<br />
]<br />
<br />
=== Типы действий ===<br />
<br />
==== skip — Пропуск маркеров ====<br />
Удаляет маркеры, соответствующие условию.<br />
...<br />
{<br />
"action": "skip",<br />
"rules": "file == 'test.cpp' and line > 100"<br />
}<br />
...<br />
<br />
==== change — Изменение маркеров ====<br />
Изменяет указанные поля маркеров.<br />
...<br />
{<br />
"action": "change",<br />
"rules": "warnclass == 'UNREACHABLE_CODE'",<br />
"change": {<br />
"warnclass": "IGNORED",<br />
"msg": "Код помечен как недостижимый"<br />
}<br />
}<br />
...<br />
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.<br />
<br />
==== deduplicate — Дедупликация ====<br />
Объединяет маркеры с одинаковыми значениями указанных полей. Один маркер выбирается случайно, все trace от остальных маркеров добавляются к нему.<br />
...<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
...<br />
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.<br />
<br />
== Доступные поля и операторы ==<br />
<br />
=== Поля маркеров ===<br />
В условиях можно использовать следующие поля:<br />
<br />
* <code>file</code> — полный путь к файлу (строка)<br />
* <code>line</code> — номер строки (число)<br />
* <code>function</code> — имя функции (строка)<br />
* <code>warnclass</code> — класс предупреждения (строка)<br />
* <code>lang</code> — язык программирования (строка)<br />
* <code>tool</code> — инструмент анализа (строка)<br />
* <code>mtid</code> — ID типа маркера (строка)<br />
* <code>msg</code> — сообщение маркера (строка)<br />
* <code>details</code> — детали маркера (строка)<br />
<br />
=== Операторы сравнения ===<br />
<br />
* <code>==</code>, <code>!=</code> — равно, не равно<br />
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел<br />
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы<br />
* <code>not</code>, <code>!</code> — логическое НЕ<br />
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)<br />
* <code>contains</code> — проверка вхождения подстроки<br />
<br />
=== Функции для работы со строками ===<br />
<br />
* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)<br />
* <code>hasPrefix(s, prefix)</code> — начинается с префикса<br />
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом<br />
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра<br />
* <code>lower(s)</code> — преобразование в нижний регистр<br />
* <code>upper(s)</code> — преобразование в верхний регистр<br />
* <code>trim(s)</code> — удаление пробелов в начале и конце строки<br />
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки<br />
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению<br />
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению<br />
<br />
== Примеры ==<br />
Часть примеров используют снимок [https://svacer.ispras.ru/mediawiki/images/6/66/Bash.zip bash]. Детекторы в данном снимке выглядят так:<br />
[[File:Edit-markers-1.png|center|thumb|967x967px]]<br />
<br />
=== Пропуск файлов ===<br />
В данном примере будут пропущены все файлы, которые находятся в папке <code>/.build/lib</code><br />
[<br />
{<br />
"action": "skip",<br />
"rules": "file contains '/.build/lib'"<br />
}<br />
]<br />
Сравнивая исходный снимок и снимок, где было применено edit-markers можно увидеть 215 пропущенных детекторов. Все они находятся в папке <code>/.build/lib</code><br />
[[File:Edit-markers-2.png|center|thumb|983x983px]]<br />
Если необходимо указать название не зависимо от регистра, то можно использовать функцию <code>icontains</code>:<br />
<br />
<code>[ { "action": "skip", "rules": "icontains(file, '/.build/lib')" } ]</code><br />
<br />
Также после применения edit-markers в информации о снимке указывается, какие правила были применены<br />
[[File:Edit-marker.png|center|thumb|971x971px]]<br />
<br />
=== Изменение класса предупреждений ===<br />
При необходимости возможно изменение полей маркера. В данном примере изменим warnclass маркеров у которых в названии есть <code>UNREACHABLE_CODE</code> и находящиеся после 1000 строки, но детектор <code>UNREACHABLE_CODE</code> изменять не будем.<br />
[<br />
{<br />
"action": "change",<br />
"rules": "warnclass contains 'UNREACHABLE_CODE' and line > 1000",<br />
"change": {<br />
"warnclass": "UNREACHABLE",<br />
"msg": "Изменено правилами edit markers"<br />
}<br />
}<br />
]<br />
[[File:Edit-markers-3.png|center|thumb|955x955px]]<br />
Указанные маркеры изменили свой детектор и описание. <br />
<br />
{{Note|text=Серьезность, Надежность и CWE привязаны к названию warnclass (детектора), поэтому, если указать''' '''несуществующий warnclass, то данные поля пропадут.}}<br />
<br />
=== Удаление дубликатов ===<br />
Если необходимо объединить несколько детекторов в один по одинаковым полям, то возможно сделать следующее действие (в качестве полей rules можно указать 8 возможных значений, см. описание deduplicate).<br />
Например, в снимке содержится множество одинаковых детекторов в одном файле на одной строке.<br />
[[File:Edit-markers-dedup.png|center|thumb|933x933px]]<br />
Применив следующее правило все маркеры, которые находятся в одном файле, с одним детектором и на одной строке объединятся в один: выберется один с наименьшим порядковым номером предупреждения в файле результатов анализа (local_id) и у него будет объединенные уникальные трассы всех остальных маркеров.<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,warnclass,line"<br />
}<br />
]<br />
[[File:Edit-markers-dedup2.png|center|thumb|948x948px]]<br />
В данном примере у всех маркеров <code>UNUSED_FIELD</code> на строке 11 в файле <code>AddInstruction.cs</code> была трасса состоящая из трёх ролей: detected, info, Current function name. Роль detected полностью совпадала во всех маркерах, она была включена один раз, а все остальные роли добавились в объединенный маркер. Оставшиеся дублирующие маркеры были удалены.<br />
<br />
=== Комплексный пример ===<br />
В данном примере пропускаются все маркеры, у которых инструмент равен <code>CSA</code>, а маркеры, которые имеют детекторы <code>'BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'</code> или имеют в описании подстроку <code>unsafe</code> в любом регистре, меняют детектор и описание.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "tool == 'CSA'"<br />
},<br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'] or icontains(msg, 'unsafe')",<br />
"change": {<br />
"warnclass": "HIGH_PRIORITY",<br />
"msg": "Высокоприоритетное предупреждение"<br />
}<br />
}<br />
]<br />
При сравнении с исходным снимком можно заметить, что 91 предупреждение, у которых инструмент был <code>CSA</code>, удалены из измененного снимка.<br />
[[File:Edit-markers-5.png|center|thumb|979x979px]]<br />
Также были изменены маркеры, в соответствии с правилами.<br />
[[File:Edit-markers-51.png|center|thumb|980x980px]]<br />
<br />
=== Изменение приоритета для определенных классов ===<br />
Изменение детекторов:<br />
[ <br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['UNREACHABLE_CODE.TERMINATION', 'UNREACHABLE_CODE.RET', 'UNREACHABLE_CODE.ENUM']",<br />
"change": {<br />
"warnclass": "UNREACHABLE_CODE"<br />
}<br />
}<br />
]<br />
<br />
=== Обработка сгенерированных файлов ===<br />
Пропускаем все маркеры в сгенерированных файлах:<br />
<br />
[ <br />
{<br />
"action": "skip",<br />
"rules": "file contains 'generated' or hasPrefix(file, 'vendor/')"<br />
}<br />
]<br />
<br />
=== Дедупликация с последующей фильтрацией ===<br />
Сначала объединяем дубликаты, потом удаляем ненужные:<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass,function"<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"<br />
}<br />
]<br />
<br />
=== Работа с регулярными выражениями ===<br />
В данном примере будут пропущены маркеры, путь к файлу которых НЕ соответствует регулярному выражению. В результате в снимке останутся только маркеры из файлов с расширениями <code>.c</code>, <code>.cpp</code>, <code>.h</code> или <code>.hpp</code>, находящихся в директории <code>/.build/builtins</code>. В данном случае мы дважды экранируем: сначала слэш, а потом точку.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "nregex(file, \"^/\\\\.build/builtins/.*\\\\.(c|cpp|h|hpp)$\")"<br />
}<br />
]<br />
В результате у нас остаются только подходящие маркеры:<br />
[[File:Edit-markers-8.png|center|thumb|979x979px]]<br />
<br />
== Дополнительные опции ==<br />
<br />
=== Сохранение отредактированного снимка ===<br />
При импорте снимка можно сохранить результат применения правил:<br />
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...<br />
Обязательно должно быть расширение <code>.snap</code> для сохранения.<br />
<br />
== Важные замечания ==<br />
<br />
# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле<br />
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей<br />
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code><br />
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)<br />
# '''Поле line в change''' — должно быть строкой с неотрицательным числом<br />
# '''Поле warnclass в change''' — может принимать только русские и английские буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Edit-markers-dedup2.png&diff=3354File:Edit-markers-dedup2.png2025-11-19T08:56:27Z<p>Gribunin: </p>
<hr />
<div>edit-markers-dedup2</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Edit-markers-dedup.png&diff=3353File:Edit-markers-dedup.png2025-11-19T08:47:04Z<p>Gribunin: </p>
<hr />
<div>edit-markers-dedup</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Edit_markers_(command_line)&diff=3342Edit markers (command line)2025-11-18T18:13:38Z<p>Gribunin: edit-markers change descriptions to more correct description</p>
<hr />
<div>== Обзор ==<br />
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:<br />
<br />
* '''skip''' — пропуск (удаление) маркеров, соответствующих условию<br />
* '''change''' — изменение полей маркеров<br />
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяется трасса и остается только один (случайный) маркер с объединенной трассой, остальные маркеры удаляются.<br />
Все операции происходят на стороне клиента до загрузки данных на сервер. При импорте результатов Svace, а также sarif (без указания флага --upload) изменяется .svacer-dir. Директория .svace-dir остается неизменной. Снимок остается неизменным при импорте. <br />
<br />
Данный функционал работает со снимками, созданными Svacer версии 7-0-0 и новее. Если у вас более старый снимок, то импортируйте и экспортируйте его для возможности работы с edit-markers.<br />
<br />
== Использование ==<br />
<br />
=== Импорт результатов Svace ===<br />
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code><br />
<br />
Применяет правила редактирования к маркерам при импорте результатов анализа Svace.<br />
<br />
=== Импорт SARIF ===<br />
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при импорте SARIF-файлов.<br />
<br />
=== Импорт снимка с редактированием ===<br />
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила к снимку при импорте. Дополнительно можно сохранить отредактированный снимок:<br />
<br />
<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code><br />
<br />
== Формат файла правил ==<br />
Правила задаются в виде JSON-файла, содержащего массив объектов правил:<br />
[<br />
{<br />
"action": "тип_действия",<br />
"rules": "условие_или_список_полей",<br />
"change": { /* только для action: "change" */ }<br />
},<br />
...<br />
]<br />
<br />
=== Типы действий ===<br />
<br />
==== skip — Пропуск маркеров ====<br />
Удаляет маркеры, соответствующие условию.<br />
...<br />
{<br />
"action": "skip",<br />
"rules": "file == 'test.cpp' and line > 100"<br />
}<br />
...<br />
<br />
==== change — Изменение маркеров ====<br />
Изменяет указанные поля маркеров.<br />
...<br />
{<br />
"action": "change",<br />
"rules": "warnclass == 'UNREACHABLE_CODE'",<br />
"change": {<br />
"warnclass": "IGNORED",<br />
"msg": "Код помечен как недостижимый"<br />
}<br />
}<br />
...<br />
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.<br />
<br />
==== deduplicate — Дедупликация ====<br />
Объединяет маркеры с одинаковыми значениями указанных полей. Один маркер выбирается случайно, все trace от остальных маркеров добавляются к нему.<br />
...<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
...<br />
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.<br />
<br />
== Доступные поля и операторы ==<br />
<br />
=== Поля маркеров ===<br />
В условиях можно использовать следующие поля:<br />
<br />
* <code>file</code> — полный путь к файлу (строка)<br />
* <code>line</code> — номер строки (число)<br />
* <code>function</code> — имя функции (строка)<br />
* <code>warnclass</code> — класс предупреждения (строка)<br />
* <code>lang</code> — язык программирования (строка)<br />
* <code>tool</code> — инструмент анализа (строка)<br />
* <code>mtid</code> — ID типа маркера (строка)<br />
* <code>msg</code> — сообщение маркера (строка)<br />
* <code>details</code> — детали маркера (строка)<br />
<br />
=== Операторы сравнения ===<br />
<br />
* <code>==</code>, <code>!=</code> — равно, не равно<br />
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел<br />
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы<br />
* <code>not</code>, <code>!</code> — логическое НЕ<br />
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)<br />
* <code>contains</code> — проверка вхождения подстроки<br />
<br />
=== Функции для работы со строками ===<br />
<br />
* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)<br />
* <code>hasPrefix(s, prefix)</code> — начинается с префикса<br />
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом<br />
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра<br />
* <code>lower(s)</code> — преобразование в нижний регистр<br />
* <code>upper(s)</code> — преобразование в верхний регистр<br />
* <code>trim(s)</code> — удаление пробелов в начале и конце строки<br />
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки<br />
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению<br />
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению<br />
<br />
== Примеры ==<br />
Все примеры используют снимок [https://svacer.ispras.ru/mediawiki/images/6/66/Bash.zip bash]. Детекторы в данном снимке выглядят так:<br />
[[File:Edit-markers-1.png|center|thumb|967x967px]]<br />
<br />
=== Пропуск файлов ===<br />
В данном примере будут пропущены все файлы, которые находятся в папке <code>/.build/lib</code><br />
[<br />
{<br />
"action": "skip",<br />
"rules": "file contains '/.build/lib'"<br />
}<br />
]<br />
Сравнивая исходный снимок и снимок, где было применено edit-markers можно увидеть 215 пропущенных детекторов. Все они находятся в папке <code>/.build/lib</code><br />
[[File:Edit-markers-2.png|center|thumb|983x983px]]<br />
Если необходимо указать название не зависимо от регистра, то можно использовать функцию <code>icontains</code>:<br />
<br />
<code>[ { "action": "skip", "rules": "icontains(file, '/.build/lib')" } ]</code><br />
<br />
Также после применения edit-markers в информации о снимке указывается, какие правила были применены<br />
[[File:Edit-marker.png|center|thumb|971x971px]]<br />
<br />
=== Изменение класса предупреждений ===<br />
При необходимости возможно изменение полей маркера. В данном примере изменим warnclass маркеров у которых в названии есть <code>UNREACHABLE_CODE</code> и находящиеся после 1000 строки, но детектор <code>UNREACHABLE_CODE</code> изменять не будем.<br />
[<br />
{<br />
"action": "change",<br />
"rules": "warnclass contains 'UNREACHABLE_CODE' and line > 1000",<br />
"change": {<br />
"warnclass": "UNREACHABLE",<br />
"msg": "Изменено правилами edit markers"<br />
}<br />
}<br />
]<br />
[[File:Edit-markers-3.png|center|thumb|955x955px]]<br />
Указанные маркеры изменили свой детектор и описание. <br />
<br />
{{Note|text=Серьезность, Надежность и CWE привязаны к названию warnclass (детектора), поэтому, если указать''' '''несуществующий warnclass, то данные поля пропадут.}}<br />
<br />
=== Удаление дубликатов ===<br />
Если необходимо объединить несколько детекторов в один по одинаковым полям, то возможно сделать следующее действие (в качестве полей rules можно указать 8 возможных значений, см. описание deduplicate):<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,warnclass"<br />
}<br />
]<br />
Тогда все маркеры, которые находятся в одном файле и с одним warnclass объединятся в один: случайным образом выберется один из них и у него будет объединенный trace всех остальных маркеров.<br />
[[File:Edit-markers-4.png|center|thumb|961x961px]]<br />
Для данного примера видно, что все маркеры из файла <code>/.build/alias.c</code> объединились в один (так как у них был один warnclass) и его trace содержит все записи других маркеров. Аналогично произошло и с остальными маркерами, которые находились в одном файле и имели одинаковые warnclass.<br />
<br />
=== Комплексный пример ===<br />
В данном примере пропускаются все маркеры, у которых инструмент равен <code>CSA</code>, а маркеры, которые имеют детекторы <code>'BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'</code> или имеют в описании подстроку <code>unsafe</code> в любом регистре, меняют детектор и описание.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "tool == 'CSA'"<br />
},<br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'] or icontains(msg, 'unsafe')",<br />
"change": {<br />
"warnclass": "HIGH_PRIORITY",<br />
"msg": "Высокоприоритетное предупреждение"<br />
}<br />
}<br />
]<br />
При сравнении с исходным снимком можно заметить, что 91 предупреждение, у которых инструмент был <code>CSA</code>, удалены из измененного снимка.<br />
[[File:Edit-markers-5.png|center|thumb|979x979px]]<br />
Также были изменены маркеры, в соответствии с правилами.<br />
[[File:Edit-markers-51.png|center|thumb|980x980px]]<br />
<br />
=== Изменение приоритета для определенных классов ===<br />
Изменение детекторов:<br />
[ <br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['UNREACHABLE_CODE.TERMINATION', 'UNREACHABLE_CODE.RET', 'UNREACHABLE_CODE.ENUM']",<br />
"change": {<br />
"warnclass": "UNREACHABLE_CODE"<br />
}<br />
}<br />
]<br />
<br />
=== Обработка сгенерированных файлов ===<br />
Пропускаем все маркеры в сгенерированных файлах:<br />
<br />
[ <br />
{<br />
"action": "skip",<br />
"rules": "file contains 'generated' or hasPrefix(file, 'vendor/')"<br />
}<br />
]<br />
<br />
=== Дедупликация с последующей фильтрацией ===<br />
Сначала объединяем дубликаты, потом удаляем ненужные:<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass,function"<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"<br />
}<br />
]<br />
<br />
=== Работа с регулярными выражениями ===<br />
В данном примере будут пропущены маркеры, путь к файлу которых НЕ соответствует регулярному выражению. В результате в снимке останутся только маркеры из файлов с расширениями <code>.c</code>, <code>.cpp</code>, <code>.h</code> или <code>.hpp</code>, находящихся в директории <code>/.build/builtins</code>. В данном случае мы дважды экранируем: сначала слэш, а потом точку.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "nregex(file, \"^/\\\\.build/builtins/.*\\\\.(c|cpp|h|hpp)$\")"<br />
}<br />
]<br />
В результате у нас остаются только подходящие маркеры:<br />
[[File:Edit-markers-8.png|center|thumb|979x979px]]<br />
<br />
== Дополнительные опции ==<br />
<br />
=== Сохранение отредактированного снимка ===<br />
При импорте снимка можно сохранить результат применения правил:<br />
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...<br />
Обязательно должно быть расширение <code>.snap</code> для сохранения.<br />
<br />
== Важные замечания ==<br />
<br />
# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле<br />
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей<br />
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code><br />
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)<br />
# '''Поле line в change''' — должно быть строкой с неотрицательным числом<br />
# '''Поле warnclass в change''' — может принимать только русские и английские буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3341Help:CLI/cleanup2025-11-18T17:38:07Z<p>Gribunin: small cleanup changes</p>
<hr />
<div>= Автоматическое удаление снимков =<br />
<br />
== Обзор ==<br />
<br />
Удаление происходит по умолчанию раз в 24 часа (время можно задать при запуске сервера опцией <code>--snapshots-cleanup-period</code>, либо в конфигурационном файле, либо переменной окружения <code>SVACER_CLEANUP_SNAPSHOTS_PERIOD</code>, но не меньше 15 минут). Первое удаление всех подходящих снимков будет выполнено через указанное время после запуска сервера.<br />
<br />
Применять может только пользователь с доступом '''ServerOperations'''.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление самых старых по времени создания подходящих снимков и заносится отметка в таблицу удаленных снимков и в системный журнал. После этого происходит удаление пустых веток и проектов в соответствии с правилами удаления. Также информация об удалении через cleanup вносится в системный журнал.<br />
<br />
== Добавление нового правила удаления ==<br />
<br />
svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --keep-time <nowiki><time></nowiki> --min-snapshots <min> --cleanup-type <type><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех проектов)<br />
* <code>--branch</code> — ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--keep-time</code> — время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней).<br />
* <code>--min-snapshots</code> — количество снимков, которое необходимо оставлять в ветке, подходящей под паттерн project + branch. По умолчанию 0<br />
* <code>--cleanup-type</code> — тип очистки. Возможные значения - project, branch, snapshot (по умолчанию snapshot). При указании snapshot будут очищаться снимки в соответствии с паттерном проект+ветка+снимок и проверяться <code>keep-time</code> и <code>min-snapshots</code>. При указании branch будут удаляться пустые ветки в соответствии с паттерном project + branch. При указании project Будут удаляться пустые проекты (у которых нет веток) в соответствии с паттерном project. При указании branch или project невозможно указать <code>keep-time</code> и <code>min-snapshots</code>, эти флаги не учитываются.<br />
<br />
=== Шаблоны и паттерны ===<br />
<br />
Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:<br />
<br />
'''1. Имя или ID:'''<br />
--project "MyProject"<br />
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта<br />
<br />
'''2. <code>*</code> (любое количество любых символов):'''<br />
--project "Dev*" # DevProject, Development<br />
--branch "*test*" # test, my-test, testing<br />
--snapshot "nightly-*"<br />
<br />
'''3. Регулярные выражения (с префиксом <code>re:</code>):'''<br />
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5<br />
--branch "re:^feature/[0-9]+$" # feature/123<br />
<br />
== Добавление запрета на удаление ==<br />
<br />
svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --min-snapshots <min><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех проектов)<br />
<br />
* <code>--branch</code> — ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.<br />
<br />
== Удаление правила ==<br />
<br />
svacer server cleanup delete --user <user> --password <password> --id <config id><br />
<br />
Где:<br />
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)<br />
<br />
== Вывести таблицу ==<br />
<br />
svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json><br />
<br />
Где:<br />
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков<br />
<br />
* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат<br />
== Запуск очистки вручную ==<br />
<br />
svacer server cleanup run --user <user> --password <password><br />
<br />
Запускает процесс очистки немедленно (вне расписания).<br />
<br />
== Примеры ==<br />
<br />
=== Добавление нового правила ===<br />
<br />
'''Удаление по времени'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --keep-time "240h"<br />
<br />
Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".<br />
<br />
'''Ограничение количества'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 20<br />
<br />
В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.<br />
<br />
'''Очистка пустых веток'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "master" --cleanup-type branch<br />
<br />
В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*"<br />
<br />
Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются правилами cleanup'''.<br />
<br />
=== Вывод таблицы правил ===<br />
<br />
svacer server cleanup list --user admin --password admin --type rule<br />
[[File:Cleanup rules.png|none|thumb|955x955px]]<br />
<br />
=== Вывод таблицы запретов ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule<br />
[[File:Cleanup exclude rule table.png|center|thumb|1009x1009px]]<br />
<br />
=== Вывод в JSON формате ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule --format json<br />
<br />
Вывод:<br />
<br />
[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]<br />
<br />
=== Удаление правила ===<br />
<br />
svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416<br />
<br />
=== Использование regex ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --keep-time 168h<br />
<br />
Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code><br>Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code><br />
<br />
=== Regex синтаксис ===<br />
<br />
{| class="wikitable"<br />
! Паттерн !! Описание !! Пример<br />
|-<br />
| <code>^</code> || Начало строки || <code>^test</code><br />
|-<br />
| <code>[^x]</code> || Отрицание символов || <code>^[^m].*$</code><br />
|-<br />
| <code>$</code> || Конец строки || <code>test$</code><br />
|-<br />
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c<br />
|-<br />
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123<br />
|-<br />
| <code>.+</code> || Один или более || <code>test.+</code> → test-1<br />
|-<br />
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9<br />
|-<br />
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc<br />
|-<br />
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC<br />
|-<br />
| <code>(a&#124;b)</code> || "a" или "b" || <code>(test&#124;prod)</code><br />
|-<br />
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code><br />
|}<br />
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.<br />
<br />
Для правил отрицания конкретного элемента возможно использовать сложные правила, например:<br />
<br />
<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code><br />
<br />
Данное правило выбирает все ветки, кроме <code>main</code>.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Edit_markers_(command_line)&diff=3322Edit markers (command line)2025-11-17T16:37:26Z<p>Gribunin: add info edit-markers version snapshot</p>
<hr />
<div>== Обзор ==<br />
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:<br />
<br />
* '''skip''' — пропуск (удаление) маркеров, соответствующих условию<br />
* '''change''' — изменение полей маркеров<br />
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяется трасса и остается только один (случайный) маркер с объединенной трассой, остальные маркеры удаляются.<br />
Все операции происходят на стороне клиента до загрузки данных на сервер. При импорте результатов Svace, а также sarif (без указания флага --upload) изменяется .svacer-dir. Директория .svace-dir остается неизменной. Снимок остается неизменным при импорте. <br />
<br />
Данный функционал работает со снимками, созданными Svacer версии 7-0-0 и новее. Если у вас более старый снимок, то импортируйте и экспортируйте его для возможности работы с edit-markers.<br />
<br />
== Использование ==<br />
<br />
=== Импорт результатов Svace ===<br />
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила редактирования к маркерам при импорте результатов анализа Svace.<br />
<br />
=== Импорт SARIF ===<br />
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при импорте SARIF-файлов.<br />
<br />
=== Импорт снимка с редактированием ===<br />
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила к снимку при импорте. Дополнительно можно сохранить отредактированный снимок:<br />
<br />
<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code><br />
<br />
== Формат файла правил ==<br />
Правила задаются в виде JSON-файла, содержащего массив объектов правил:<br />
[<br />
{<br />
"action": "тип_действия",<br />
"rules": "условие_или_список_полей",<br />
"change": { /* только для action: "change" */ }<br />
},<br />
...<br />
]<br />
<br />
=== Типы действий ===<br />
<br />
==== skip — Пропуск маркеров ====<br />
Удаляет маркеры, соответствующие условию.<br />
...<br />
{<br />
"action": "skip",<br />
"rules": "file == 'test.cpp' and line > 100"<br />
}<br />
...<br />
<br />
==== change — Изменение маркеров ====<br />
Изменяет указанные поля маркеров.<br />
...<br />
{<br />
<nowiki> </nowiki>"action": "change",<br />
<nowiki> </nowiki>"rules": "warnclass == 'UNREACHABLE_CODE'",<br />
<nowiki> </nowiki>"change": {<br />
<nowiki> </nowiki> "warnclass": "IGNORED",<br />
<nowiki> </nowiki> "msg": "Код помечен как недостижимый"<br />
<nowiki> </nowiki>}<br />
}<br />
...<br />
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.<br />
<br />
==== deduplicate — Дедупликация ====<br />
Объединяет маркеры с одинаковыми значениями указанных полей. Один маркер выбирается случайно, все trace от остальных маркеров добавляются к нему.<br />
...<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
...<br />
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.<br />
<br />
== Доступные поля и операторы ==<br />
<br />
=== Поля маркеров ===<br />
В условиях можно использовать следующие поля:<br />
<br />
* <code>file</code> — полный путь к файлу (строка)<br />
* <code>line</code> — номер строки (число)<br />
* <code>function</code> — имя функции (строка)<br />
* <code>warnclass</code> — класс предупреждения (строка)<br />
* <code>lang</code> — язык программирования (строка)<br />
* <code>tool</code> — инструмент анализа (строка)<br />
* <code>mtid</code> — ID типа маркера (строка)<br />
* <code>msg</code> — сообщение маркера (строка)<br />
* <code>details</code> — детали маркера (строка)<br />
<br />
=== Операторы сравнения ===<br />
<br />
* <code>==</code>, <code>!=</code> — равно, не равно<br />
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел<br />
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы<br />
* <code>not</code>, <code>!</code> — логическое НЕ<br />
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)<br />
* <code>contains</code> — проверка вхождения подстроки<br />
<br />
=== Функции для работы со строками ===<br />
<br />
* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)<br />
* <code>hasPrefix(s, prefix)</code> — начинается с префикса<br />
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом<br />
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра<br />
* <code>lower(s)</code> — преобразование в нижний регистр<br />
* <code>upper(s)</code> — преобразование в верхний регистр<br />
* <code>trim(s)</code> — удаление пробелов в начале и конце строки<br />
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки<br />
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению<br />
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению<br />
<br />
== Примеры ==<br />
Все примеры используют снимок [https://svacer.ispras.ru/mediawiki/images/6/66/Bash.zip bash]. Детекторы в данном снимке выглядят так:<br />
[[File:Edit-markers-1.png|center|thumb|967x967px]]<br />
<br />
=== Пропуск файлов ===<br />
В данном примере будут пропущены все файлы, которые находятся в папке <code>/.build/lib</code><br />
[<br />
{<br />
"action": "skip",<br />
"rules": "file contains '/.build/lib'"<br />
}<br />
]<br />
Сравнивая исходный снимок и снимок, где было применено edit-markers можно увидеть 215 пропущенных детекторов. Все они находятся в папке <code>/.build/lib</code><br />
[[File:Edit-markers-2.png|center|thumb|983x983px]]<br />
Если необходимо указать название не зависимо от регистра, то можно использовать функцию <code>icontains</code>:<br />
<br />
<code>[ { "action": "skip", "rules": "icontains(file, '/.build/lib')" } ]</code><br />
<br />
Также после применения edit-markers в информации о снимке указывается, какие правила были применены<br />
[[File:Edit-marker.png|center|thumb|971x971px]]<br />
<br />
=== Изменение класса предупреждений ===<br />
При необходимости возможно изменение полей маркера. В данном примере изменим warnclass маркеров у которых в названии есть <code>UNREACHABLE_CODE</code> и находящиеся после 1000 строки, но детектор <code>UNREACHABLE_CODE</code> изменять не будем.<br />
[<br />
{<br />
"action": "change",<br />
"rules": "warnclass contains 'UNREACHABLE_CODE' and line > 1000",<br />
"change": {<br />
"warnclass": "UNREACHABLE",<br />
"msg": "Изменено правилами edit markers"<br />
}<br />
}<br />
]<br />
[[File:Edit-markers-3.png|center|thumb|955x955px]]<br />
Указанные маркеры изменили свой детектор и описание. <br />
<br />
'''Серьезность, Надежность и CWE привязаны к названию warnclass (детектора), поэтому, если указать''' '''несуществующий warnclass, то данные поля пропадут.'''<br />
<br />
=== Удаление дубликатов ===<br />
Если необходимо объединить несколько детекторов в один по одинаковым полям, то возможно сделать следующее действие (в качестве полей rules можно указать 8 возможных значений, см. описание deduplicate):<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,warnclass"<br />
}<br />
]<br />
Тогда все маркеры, которые находятся в одном файле и с одним warnclass объединятся в один (случайным образом выберется один) и у него будет объединенный trace всех остальным маркеров.<br />
[[File:Edit-markers-4.png|center|thumb|961x961px]]<br />
Для данного примера видно, что все маркеры из файла <code>/.build/alias.c</code> объединились в один (так как у них был один warnclass) и их trace содержит все записи других маркеров. Аналогично произошло и с остальными маркерами, которые находились в одном файле и имели одинаковые warnclass.<br />
<br />
=== Комплексный пример ===<br />
В данном примере пропускаются все маркеры, у которых инструмент равен <code>CSA</code>, а маркеры, которые имеют детекторы <code>'BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'</code> или имеют в описании подстроку <code>unsafe</code> в любом регистре, меняют детектор и описание.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "tool == 'CSA'"<br />
},<br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'] or icontains(msg, 'unsafe')",<br />
"change": {<br />
"warnclass": "HIGH_PRIORITY",<br />
"msg": "Высокоприоритетное предупреждение"<br />
}<br />
}<br />
]<br />
При сравнении с исходным снимком можно заметить, что 91 предупреждение, у которых инструмент был <code>CSA</code> удалены из измененного снимка.<br />
[[File:Edit-markers-5.png|center|thumb|979x979px]]<br />
Также были изменены маркеры, в соответствии с правилами.<br />
[[File:Edit-markers-51.png|center|thumb|980x980px]]<br />
<br />
=== Изменение приоритета для определенных классов ===<br />
Изменение детекторов:<br />
[ <br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['UNREACHABLE_CODE.TERMINATION', 'UNREACHABLE_CODE.RET', 'UNREACHABLE_CODE.ENUM']",<br />
"change": {<br />
"warnclass": "UNREACHABLE_CODE"<br />
}<br />
}<br />
]<br />
<br />
=== Обработка сгенерированных файлов ===<br />
Пропускаем все маркеры в сгенерированных файлах:<br />
<br />
[ <br />
{<br />
"action": "skip",<br />
"rules": "file contains 'generated' or hasPrefix(file, 'vendor/')"<br />
}<br />
]<br />
<br />
=== Дедупликация с последующей фильтрацией ===<br />
Сначала объединяем дубликаты, потом удаляем ненужные:<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass,function"<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"<br />
}<br />
]<br />
<br />
=== Работа с регулярными выражениями ===<br />
Фильтрация по сложным паттернам путей. В данном случае будут пропущены маркеры, которые НЕ находятся в <code>/.build/builtins</code>, а также у них расширение не <code>c, cpp, h, hpp</code> (то есть оставляем только те маркеры, которые находятся в папке <code>/.build/builtins</code> с расширением <code>c, cpp, h, hpp</code>). В данном случае мы дважды экранируем: сначала слэш, а потом точку.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "nregex(file, \"^/\\\\.build/builtins/.*\\\\.(c|cpp|h|hpp)$\")"<br />
}<br />
]<br />
В результате у нас остаются только подходящие маркеры:<br />
[[File:Edit-markers-8.png|center|thumb|979x979px]]<br />
<br />
== Дополнительные опции ==<br />
<br />
=== Сохранение отредактированного снимка ===<br />
При импорте снимка можно сохранить результат применения правил:<br />
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...<br />
Обязательно должно быть расширение <code>.snap</code> для сохранения.<br />
<br />
== Важные замечания ==<br />
<br />
# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле<br />
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей<br />
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code><br />
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)<br />
# '''Поле line в change''' — должно быть строкой с неотрицательным числом<br />
# '''Поле warnclass в change''' — может принимать только русские, английский буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Edit_markers_(command_line)&diff=3321Edit markers (command line)2025-11-17T15:44:34Z<p>Gribunin: /* Примеры */</p>
<hr />
<div>== Обзор ==<br />
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:<br />
<br />
* '''skip''' — пропуск (удаление) маркеров, соответствующих условию<br />
* '''change''' — изменение полей маркеров<br />
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяется трасса и остается только один (случайный) маркер с объединенной трассой, остальные маркеры удаляются.<br />
Все операции происходят на стороне клиента до загрузки данных на сервер. При импорте результатов Svace, а также sarif (без указания флага --upload) изменяется .svacer-dir. Директория .svace-dir остается неизменной. Снимок остается неизменным при импорте.<br />
<br />
== Использование ==<br />
<br />
=== Импорт результатов Svace ===<br />
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила редактирования к маркерам при импорте результатов анализа Svace.<br />
<br />
=== Импорт SARIF ===<br />
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при импорте SARIF-файлов.<br />
<br />
=== Импорт снимка с редактированием ===<br />
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила к снимку при импорте. Дополнительно можно сохранить отредактированный снимок:<br />
<br />
<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code><br />
<br />
== Формат файла правил ==<br />
Правила задаются в виде JSON-файла, содержащего массив объектов правил:<br />
[<br />
{<br />
"action": "тип_действия",<br />
"rules": "условие_или_список_полей",<br />
"change": { /* только для action: "change" */ }<br />
},<br />
...<br />
]<br />
<br />
=== Типы действий ===<br />
<br />
==== skip — Пропуск маркеров ====<br />
Удаляет маркеры, соответствующие условию.<br />
...<br />
{<br />
"action": "skip",<br />
"rules": "file == 'test.cpp' and line > 100"<br />
}<br />
...<br />
<br />
==== change — Изменение маркеров ====<br />
Изменяет указанные поля маркеров.<br />
...<br />
{<br />
<nowiki> </nowiki>"action": "change",<br />
<nowiki> </nowiki>"rules": "warnclass == 'UNREACHABLE_CODE'",<br />
<nowiki> </nowiki>"change": {<br />
<nowiki> </nowiki> "warnclass": "IGNORED",<br />
<nowiki> </nowiki> "msg": "Код помечен как недостижимый"<br />
<nowiki> </nowiki>}<br />
}<br />
...<br />
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.<br />
<br />
==== deduplicate — Дедупликация ====<br />
Объединяет маркеры с одинаковыми значениями указанных полей. Один маркер выбирается случайно, все trace от остальных маркеров добавляются к нему.<br />
...<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
...<br />
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.<br />
<br />
== Доступные поля и операторы ==<br />
<br />
=== Поля маркеров ===<br />
В условиях можно использовать следующие поля:<br />
<br />
* <code>file</code> — полный путь к файлу (строка)<br />
* <code>line</code> — номер строки (число)<br />
* <code>function</code> — имя функции (строка)<br />
* <code>warnclass</code> — класс предупреждения (строка)<br />
* <code>lang</code> — язык программирования (строка)<br />
* <code>tool</code> — инструмент анализа (строка)<br />
* <code>mtid</code> — ID типа маркера (строка)<br />
* <code>msg</code> — сообщение маркера (строка)<br />
* <code>details</code> — детали маркера (строка)<br />
<br />
=== Операторы сравнения ===<br />
<br />
* <code>==</code>, <code>!=</code> — равно, не равно<br />
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел<br />
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы<br />
* <code>not</code>, <code>!</code> — логическое НЕ<br />
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)<br />
* <code>contains</code> — проверка вхождения подстроки<br />
<br />
=== Функции для работы со строками ===<br />
<br />
* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)<br />
* <code>hasPrefix(s, prefix)</code> — начинается с префикса<br />
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом<br />
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра<br />
* <code>lower(s)</code> — преобразование в нижний регистр<br />
* <code>upper(s)</code> — преобразование в верхний регистр<br />
* <code>trim(s)</code> — удаление пробелов в начале и конце строки<br />
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки<br />
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению<br />
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению<br />
<br />
== Примеры ==<br />
Все примеры используют снимок [https://svacer.ispras.ru/mediawiki/images/6/66/Bash.zip bash]. Детекторы в данном снимке выглядят так:<br />
[[File:Edit-markers-1.png|center|thumb|967x967px]]<br />
<br />
=== Пропуск файлов ===<br />
В данном примере будут пропущены все файлы, которые находятся в папке <code>/.build/lib</code><br />
[<br />
{<br />
"action": "skip",<br />
"rules": "file contains '/.build/lib'"<br />
}<br />
]<br />
Сравнивая исходный снимок и снимок, где было применено edit-markers можно увидеть 215 пропущенных детекторов. Все они находятся в папке <code>/.build/lib</code><br />
[[File:Edit-markers-2.png|center|thumb|983x983px]]<br />
Если необходимо указать название не зависимо от регистра, то можно использовать функцию <code>icontains</code>:<br />
<br />
<code>[ { "action": "skip", "rules": "icontains(file, '/.build/lib')" } ]</code><br />
<br />
Также после применения edit-markers в информации о снимке указывается, какие правила были применены<br />
[[File:Edit-marker.png|center|thumb|971x971px]]<br />
<br />
=== Изменение класса предупреждений ===<br />
При необходимости возможно изменение полей маркера. В данном примере изменим warnclass маркеров у которых в названии есть <code>UNREACHABLE_CODE</code> и находящиеся после 1000 строки, но детектор <code>UNREACHABLE_CODE</code> изменять не будем.<br />
[<br />
{<br />
"action": "change",<br />
"rules": "warnclass contains 'UNREACHABLE_CODE' and line > 1000",<br />
"change": {<br />
"warnclass": "UNREACHABLE",<br />
"msg": "Изменено правилами edit markers"<br />
}<br />
}<br />
]<br />
[[File:Edit-markers-3.png|center|thumb|955x955px]]<br />
Указанные маркеры изменили свой детектор и описание. <br />
<br />
'''Серьезность, Надежность и CWE привязаны к названию warnclass (детектора), поэтому, если указать''' '''несуществующий warnclass, то данные поля пропадут.'''<br />
<br />
=== Удаление дубликатов ===<br />
Если необходимо объединить несколько детекторов в один по одинаковым полям, то возможно сделать следующее действие (в качестве полей rules можно указать 8 возможных значений, см. описание deduplicate):<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,warnclass"<br />
}<br />
]<br />
Тогда все маркеры, которые находятся в одном файле и с одним warnclass объединятся в один (случайным образом выберется один) и у него будет объединенный trace всех остальным маркеров.<br />
[[File:Edit-markers-4.png|center|thumb|961x961px]]<br />
Для данного примера видно, что все маркеры из файла <code>/.build/alias.c</code> объединились в один (так как у них был один warnclass) и их trace содержит все записи других маркеров. Аналогично произошло и с остальными маркерами, которые находились в одном файле и имели одинаковые warnclass.<br />
<br />
=== Комплексный пример ===<br />
В данном примере пропускаются все маркеры, у которых инструмент равен <code>CSA</code>, а маркеры, которые имеют детекторы <code>'BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'</code> или имеют в описании подстроку <code>unsafe</code> в любом регистре, меняют детектор и описание.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "tool == 'CSA'"<br />
},<br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'] or icontains(msg, 'unsafe')",<br />
"change": {<br />
"warnclass": "HIGH_PRIORITY",<br />
"msg": "Высокоприоритетное предупреждение"<br />
}<br />
}<br />
]<br />
При сравнении с исходным снимком можно заметить, что 91 предупреждение, у которых инструмент был <code>CSA</code> удалены из измененного снимка.<br />
[[File:Edit-markers-5.png|center|thumb|979x979px]]<br />
Также были изменены маркеры, в соответствии с правилами.<br />
[[File:Edit-markers-51.png|center|thumb|980x980px]]<br />
<br />
=== Изменение приоритета для определенных классов ===<br />
Изменение детекторов:<br />
[ <br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['UNREACHABLE_CODE.TERMINATION', 'UNREACHABLE_CODE.RET', 'UNREACHABLE_CODE.ENUM']",<br />
"change": {<br />
"warnclass": "UNREACHABLE_CODE"<br />
}<br />
}<br />
]<br />
<br />
=== Обработка сгенерированных файлов ===<br />
Пропускаем все маркеры в сгенерированных файлах:<br />
<br />
[ <br />
{<br />
"action": "skip",<br />
"rules": "file contains 'generated' or hasPrefix(file, 'vendor/')"<br />
}<br />
]<br />
<br />
=== Дедупликация с последующей фильтрацией ===<br />
Сначала объединяем дубликаты, потом удаляем ненужные:<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass,function"<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"<br />
}<br />
]<br />
<br />
=== Работа с регулярными выражениями ===<br />
Фильтрация по сложным паттернам путей. В данном случае будут пропущены маркеры, которые НЕ находятся в <code>/.build/builtins</code>, а также у них расширение не <code>c, cpp, h, hpp</code> (то есть оставляем только те маркеры, которые находятся в папке <code>/.build/builtins</code> с расширением <code>c, cpp, h, hpp</code>). В данном случае мы дважды экранируем: сначала слэш, а потом точку.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "nregex(file, \"^/\\\\.build/builtins/.*\\\\.(c|cpp|h|hpp)$\")"<br />
}<br />
]<br />
В результате у нас остаются только подходящие маркеры:<br />
[[File:Edit-markers-8.png|center|thumb|979x979px]]<br />
<br />
== Дополнительные опции ==<br />
<br />
=== Сохранение отредактированного снимка ===<br />
При импорте снимка можно сохранить результат применения правил:<br />
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...<br />
Обязательно должно быть расширение <code>.snap</code> для сохранения.<br />
<br />
== Важные замечания ==<br />
<br />
# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле<br />
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей<br />
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code><br />
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)<br />
# '''Поле line в change''' — должно быть строкой с неотрицательным числом<br />
# '''Поле warnclass в change''' — может принимать только русские, английский буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Edit-marker.png&diff=3320File:Edit-marker.png2025-11-17T15:44:19Z<p>Gribunin: </p>
<hr />
<div>edit-marker</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Edit_markers_(command_line)&diff=3319Edit markers (command line)2025-11-17T15:42:04Z<p>Gribunin: /* Примеры */</p>
<hr />
<div>== Обзор ==<br />
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:<br />
<br />
* '''skip''' — пропуск (удаление) маркеров, соответствующих условию<br />
* '''change''' — изменение полей маркеров<br />
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяется трасса и остается только один (случайный) маркер с объединенной трассой, остальные маркеры удаляются.<br />
Все операции происходят на стороне клиента до загрузки данных на сервер. При импорте результатов Svace, а также sarif (без указания флага --upload) изменяется .svacer-dir. Директория .svace-dir остается неизменной. Снимок остается неизменным при импорте.<br />
<br />
== Использование ==<br />
<br />
=== Импорт результатов Svace ===<br />
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила редактирования к маркерам при импорте результатов анализа Svace.<br />
<br />
=== Импорт SARIF ===<br />
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при импорте SARIF-файлов.<br />
<br />
=== Импорт снимка с редактированием ===<br />
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила к снимку при импорте. Дополнительно можно сохранить отредактированный снимок:<br />
<br />
<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code><br />
<br />
== Формат файла правил ==<br />
Правила задаются в виде JSON-файла, содержащего массив объектов правил:<br />
[<br />
{<br />
"action": "тип_действия",<br />
"rules": "условие_или_список_полей",<br />
"change": { /* только для action: "change" */ }<br />
},<br />
...<br />
]<br />
<br />
=== Типы действий ===<br />
<br />
==== skip — Пропуск маркеров ====<br />
Удаляет маркеры, соответствующие условию.<br />
...<br />
{<br />
"action": "skip",<br />
"rules": "file == 'test.cpp' and line > 100"<br />
}<br />
...<br />
<br />
==== change — Изменение маркеров ====<br />
Изменяет указанные поля маркеров.<br />
...<br />
{<br />
<nowiki> </nowiki>"action": "change",<br />
<nowiki> </nowiki>"rules": "warnclass == 'UNREACHABLE_CODE'",<br />
<nowiki> </nowiki>"change": {<br />
<nowiki> </nowiki> "warnclass": "IGNORED",<br />
<nowiki> </nowiki> "msg": "Код помечен как недостижимый"<br />
<nowiki> </nowiki>}<br />
}<br />
...<br />
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.<br />
<br />
==== deduplicate — Дедупликация ====<br />
Объединяет маркеры с одинаковыми значениями указанных полей. Один маркер выбирается случайно, все trace от остальных маркеров добавляются к нему.<br />
...<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
...<br />
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.<br />
<br />
== Доступные поля и операторы ==<br />
<br />
=== Поля маркеров ===<br />
В условиях можно использовать следующие поля:<br />
<br />
* <code>file</code> — полный путь к файлу (строка)<br />
* <code>line</code> — номер строки (число)<br />
* <code>function</code> — имя функции (строка)<br />
* <code>warnclass</code> — класс предупреждения (строка)<br />
* <code>lang</code> — язык программирования (строка)<br />
* <code>tool</code> — инструмент анализа (строка)<br />
* <code>mtid</code> — ID типа маркера (строка)<br />
* <code>msg</code> — сообщение маркера (строка)<br />
* <code>details</code> — детали маркера (строка)<br />
<br />
=== Операторы сравнения ===<br />
<br />
* <code>==</code>, <code>!=</code> — равно, не равно<br />
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел<br />
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы<br />
* <code>not</code>, <code>!</code> — логическое НЕ<br />
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)<br />
* <code>contains</code> — проверка вхождения подстроки<br />
<br />
=== Функции для работы со строками ===<br />
<br />
* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)<br />
* <code>hasPrefix(s, prefix)</code> — начинается с префикса<br />
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом<br />
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра<br />
* <code>lower(s)</code> — преобразование в нижний регистр<br />
* <code>upper(s)</code> — преобразование в верхний регистр<br />
* <code>trim(s)</code> — удаление пробелов в начале и конце строки<br />
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки<br />
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению<br />
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению<br />
<br />
== Примеры ==<br />
Все примеры используют снимок [https://svacer.ispras.ru/mediawiki/images/6/66/Bash.zip bash]. Детекторы в данном снимке выглядят так:<br />
[[File:Edit-markers-1.png|center|thumb|967x967px]]<br />
<br />
=== Пропуск файлов ===<br />
В данном примере будут пропущены все файлы, которые находятся в папке <code>/.build/lib</code><br />
[<br />
{<br />
"action": "skip",<br />
"rules": "file contains '/.build/lib'"<br />
}<br />
]<br />
Сравнивая исходный снимок и снимок, где было применено edit-markers можно увидеть 215 пропущенных детекторов. Все они находятся в папке <code>/.build/lib</code><br />
[[File:Edit-markers-2.png|center|thumb|983x983px]]<br />
Если необходимо указать название не зависимо от регистра, то можно использовать функцию <code>icontains</code>:<br />
<br />
<code>[ { "action": "skip", "rules": "icontains(file, '/.build/lib')" } ]</code><br />
<br />
=== Изменение класса предупреждений ===<br />
При необходимости возможно изменение полей маркера. В данном примере изменим warnclass маркеров у которых в названии есть <code>UNREACHABLE_CODE</code> и находящиеся после 1000 строки, но детектор <code>UNREACHABLE_CODE</code> изменять не будем.<br />
[<br />
{<br />
"action": "change",<br />
"rules": "warnclass contains 'UNREACHABLE_CODE' and line > 1000",<br />
"change": {<br />
"warnclass": "UNREACHABLE",<br />
"msg": "Изменено правилами edit markers"<br />
}<br />
}<br />
]<br />
[[File:Edit-markers-3.png|center|thumb|955x955px]]<br />
Указанные маркеры изменили свой детектор и описание. <br />
<br />
'''Серьезность, Надежность и CWE привязаны к названию warnclass (детектора), поэтому, если указать''' '''несуществующий warnclass, то данные поля пропадут.'''<br />
<br />
=== Удаление дубликатов ===<br />
Если необходимо объединить несколько детекторов в один по одинаковым полям, то возможно сделать следующее действие (в качестве полей rules можно указать 8 возможных значений, см. описание deduplicate):<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,warnclass"<br />
}<br />
]<br />
Тогда все маркеры, которые находятся в одном файле и с одним warnclass объединятся в один (случайным образом выберется один) и у него будет объединенный trace всех остальным маркеров.<br />
[[File:Edit-markers-4.png|center|thumb|961x961px]]<br />
Для данного примера видно, что все маркеры из файла <code>/.build/alias.c</code> объединились в один (так как у них был один warnclass) и их trace содержит все записи других маркеров. Аналогично произошло и с остальными маркерами, которые находились в одном файле и имели одинаковые warnclass.<br />
<br />
=== Комплексный пример ===<br />
В данном примере пропускаются все маркеры, у которых инструмент равен <code>CSA</code>, а маркеры, которые имеют детекторы <code>'BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'</code> или имеют в описании подстроку <code>unsafe</code> в любом регистре, меняют детектор и описание.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "tool == 'CSA'"<br />
},<br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'] or icontains(msg, 'unsafe')",<br />
"change": {<br />
"warnclass": "HIGH_PRIORITY",<br />
"msg": "Высокоприоритетное предупреждение"<br />
}<br />
}<br />
]<br />
При сравнении с исходным снимком можно заметить, что 91 предупреждение, у которых инструмент был <code>CSA</code> удалены из измененного снимка.<br />
[[File:Edit-markers-5.png|center|thumb|979x979px]]<br />
Также были изменены маркеры, в соответствии с правилами.<br />
[[File:Edit-markers-51.png|center|thumb|980x980px]]<br />
<br />
=== Изменение приоритета для определенных классов ===<br />
Изменение детекторов:<br />
[ <br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['UNREACHABLE_CODE.TERMINATION', 'UNREACHABLE_CODE.RET', 'UNREACHABLE_CODE.ENUM']",<br />
"change": {<br />
"warnclass": "UNREACHABLE_CODE"<br />
}<br />
}<br />
]<br />
<br />
=== Обработка сгенерированных файлов ===<br />
Пропускаем все маркеры в сгенерированных файлах:<br />
<br />
[ <br />
{<br />
"action": "skip",<br />
"rules": "file contains 'generated' or hasPrefix(file, 'vendor/')"<br />
}<br />
]<br />
<br />
=== Дедупликация с последующей фильтрацией ===<br />
Сначала объединяем дубликаты, потом удаляем ненужные:<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass,function"<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"<br />
}<br />
]<br />
<br />
=== Работа с регулярными выражениями ===<br />
Фильтрация по сложным паттернам путей. В данном случае будут пропущены маркеры, которые НЕ находятся в <code>/.build/builtins</code>, а также у них расширение не <code>c, cpp, h, hpp</code> (то есть оставляем только те маркеры, которые находятся в папке <code>/.build/builtins</code> с расширением <code>c, cpp, h, hpp</code>). В данном случае мы дважды экранируем: сначала слэш, а потом точку.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "nregex(file, \"^/\\\\.build/builtins/.*\\\\.(c|cpp|h|hpp)$\")"<br />
}<br />
]<br />
В результате у нас остаются только подходящие маркеры:<br />
[[File:Edit-markers-8.png|center|thumb|979x979px]]<br />
<br />
== Дополнительные опции ==<br />
<br />
=== Сохранение отредактированного снимка ===<br />
При импорте снимка можно сохранить результат применения правил:<br />
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...<br />
Обязательно должно быть расширение <code>.snap</code> для сохранения.<br />
<br />
== Важные замечания ==<br />
<br />
# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле<br />
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей<br />
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code><br />
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)<br />
# '''Поле line в change''' — должно быть строкой с неотрицательным числом<br />
# '''Поле warnclass в change''' — может принимать только русские, английский буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Edit_markers_(command_line)&diff=3318Edit markers (command line)2025-11-17T15:40:36Z<p>Gribunin: /* Примеры */</p>
<hr />
<div>== Обзор ==<br />
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:<br />
<br />
* '''skip''' — пропуск (удаление) маркеров, соответствующих условию<br />
* '''change''' — изменение полей маркеров<br />
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяется трасса и остается только один (случайный) маркер с объединенной трассой, остальные маркеры удаляются.<br />
Все операции происходят на стороне клиента до загрузки данных на сервер. При импорте результатов Svace, а также sarif (без указания флага --upload) изменяется .svacer-dir. Директория .svace-dir остается неизменной. Снимок остается неизменным при импорте.<br />
<br />
== Использование ==<br />
<br />
=== Импорт результатов Svace ===<br />
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила редактирования к маркерам при импорте результатов анализа Svace.<br />
<br />
=== Импорт SARIF ===<br />
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при импорте SARIF-файлов.<br />
<br />
=== Импорт снимка с редактированием ===<br />
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила к снимку при импорте. Дополнительно можно сохранить отредактированный снимок:<br />
<br />
<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code><br />
<br />
== Формат файла правил ==<br />
Правила задаются в виде JSON-файла, содержащего массив объектов правил:<br />
[<br />
{<br />
"action": "тип_действия",<br />
"rules": "условие_или_список_полей",<br />
"change": { /* только для action: "change" */ }<br />
},<br />
...<br />
]<br />
<br />
=== Типы действий ===<br />
<br />
==== skip — Пропуск маркеров ====<br />
Удаляет маркеры, соответствующие условию.<br />
...<br />
{<br />
"action": "skip",<br />
"rules": "file == 'test.cpp' and line > 100"<br />
}<br />
...<br />
<br />
==== change — Изменение маркеров ====<br />
Изменяет указанные поля маркеров.<br />
...<br />
{<br />
<nowiki> </nowiki>"action": "change",<br />
<nowiki> </nowiki>"rules": "warnclass == 'UNREACHABLE_CODE'",<br />
<nowiki> </nowiki>"change": {<br />
<nowiki> </nowiki> "warnclass": "IGNORED",<br />
<nowiki> </nowiki> "msg": "Код помечен как недостижимый"<br />
<nowiki> </nowiki>}<br />
}<br />
...<br />
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.<br />
<br />
==== deduplicate — Дедупликация ====<br />
Объединяет маркеры с одинаковыми значениями указанных полей. Один маркер выбирается случайно, все trace от остальных маркеров добавляются к нему.<br />
...<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
...<br />
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.<br />
<br />
== Доступные поля и операторы ==<br />
<br />
=== Поля маркеров ===<br />
В условиях можно использовать следующие поля:<br />
<br />
* <code>file</code> — полный путь к файлу (строка)<br />
* <code>line</code> — номер строки (число)<br />
* <code>function</code> — имя функции (строка)<br />
* <code>warnclass</code> — класс предупреждения (строка)<br />
* <code>lang</code> — язык программирования (строка)<br />
* <code>tool</code> — инструмент анализа (строка)<br />
* <code>mtid</code> — ID типа маркера (строка)<br />
* <code>msg</code> — сообщение маркера (строка)<br />
* <code>details</code> — детали маркера (строка)<br />
<br />
=== Операторы сравнения ===<br />
<br />
* <code>==</code>, <code>!=</code> — равно, не равно<br />
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел<br />
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы<br />
* <code>not</code>, <code>!</code> — логическое НЕ<br />
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)<br />
* <code>contains</code> — проверка вхождения подстроки<br />
<br />
=== Функции для работы со строками ===<br />
<br />
* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)<br />
* <code>hasPrefix(s, prefix)</code> — начинается с префикса<br />
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом<br />
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра<br />
* <code>lower(s)</code> — преобразование в нижний регистр<br />
* <code>upper(s)</code> — преобразование в верхний регистр<br />
* <code>trim(s)</code> — удаление пробелов в начале и конце строки<br />
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки<br />
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению<br />
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению<br />
<br />
== Примеры ==<br />
Все примеры используют снимок [./Https://svacer.ispras.ru/mediawiki/images/6/66/Bash.zip bash]. Детекторы в данном снимке выглядят так:<br />
[[File:Edit-markers-1.png|center|thumb|967x967px]]<br />
<br />
=== Пропуск файлов ===<br />
В данном примере будут пропущены все файлы, которые находятся в папке <code>/.build/lib</code><br />
[<br />
{<br />
"action": "skip",<br />
"rules": "file contains '/.build/lib'"<br />
}<br />
]<br />
Сравнивая исходный снимок и снимок, где было применено edit-markers можно увидеть 215 пропущенных детекторов. Все они находятся в папке <code>/.build/lib</code><br />
[[File:Edit-markers-2.png|center|thumb|983x983px]]<br />
Если необходимо указать название не зависимо от регистра, то можно использовать функцию <code>icontains</code>:<br />
<br />
<code>[ { "action": "skip", "rules": "icontains(file, '/.build/lib')" } ]</code><br />
<br />
=== Изменение класса предупреждений ===<br />
При необходимости возможно изменение полей маркера. В данном примере изменим warnclass маркеров у которых в названии есть <code>UNREACHABLE_CODE</code> и находящиеся после 1000 строки, но детектор <code>UNREACHABLE_CODE</code> изменять не будем.<br />
[<br />
{<br />
"action": "change",<br />
"rules": "warnclass contains 'UNREACHABLE_CODE' and line > 1000",<br />
"change": {<br />
"warnclass": "UNREACHABLE",<br />
"msg": "Изменено правилами edit markers"<br />
}<br />
}<br />
]<br />
[[File:Edit-markers-3.png|center|thumb|955x955px]]<br />
Указанные маркеры изменили свой детектор и описание. <br />
<br />
'''Серьезность, Надежность и CWE привязаны к названию warnclass (детектора), поэтому, если указать''' '''несуществующий warnclass, то данные поля пропадут.'''<br />
<br />
=== Удаление дубликатов ===<br />
Если необходимо объединить несколько детекторов в один по одинаковым полям, то возможно сделать следующее действие (в качестве полей rules можно указать 8 возможных значений, см. описание deduplicate):<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,warnclass"<br />
}<br />
]<br />
Тогда все маркеры, которые находятся в одном файле и с одним warnclass объединятся в один (случайным образом выберется один) и у него будет объединенный trace всех остальным маркеров.<br />
[[File:Edit-markers-4.png|center|thumb|961x961px]]<br />
Для данного примера видно, что все маркеры из файла <code>/.build/alias.c</code> объединились в один (так как у них был один warnclass) и их trace содержит все записи других маркеров. Аналогично произошло и с остальными маркерами, которые находились в одном файле и имели одинаковые warnclass.<br />
<br />
=== Комплексный пример ===<br />
В данном примере пропускаются все маркеры, у которых инструмент равен <code>CSA</code>, а маркеры, которые имеют детекторы <code>'BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'</code> или имеют в описании подстроку <code>unsafe</code> в любом регистре, меняют детектор и описание.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "tool == 'CSA'"<br />
},<br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'] or icontains(msg, 'unsafe')",<br />
"change": {<br />
"warnclass": "HIGH_PRIORITY",<br />
"msg": "Высокоприоритетное предупреждение"<br />
}<br />
}<br />
]<br />
При сравнении с исходным снимком можно заметить, что 91 предупреждение, у которых инструмент был <code>CSA</code> удалены из измененного снимка.<br />
[[File:Edit-markers-5.png|center|thumb|979x979px]]<br />
Также были изменены маркеры, в соответствии с правилами.<br />
[[File:Edit-markers-51.png|center|thumb|980x980px]]<br />
<br />
=== Изменение приоритета для определенных классов ===<br />
Изменение детекторов:<br />
[ <br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['UNREACHABLE_CODE.TERMINATION', 'UNREACHABLE_CODE.RET', 'UNREACHABLE_CODE.ENUM']",<br />
"change": {<br />
"warnclass": "UNREACHABLE_CODE"<br />
}<br />
}<br />
]<br />
<br />
=== Обработка сгенерированных файлов ===<br />
Пропускаем все маркеры в сгенерированных файлах:<br />
<br />
[ <br />
{<br />
"action": "skip",<br />
"rules": "file contains 'generated' or hasPrefix(file, 'vendor/')"<br />
}<br />
]<br />
<br />
=== Дедупликация с последующей фильтрацией ===<br />
Сначала объединяем дубликаты, потом удаляем ненужные:<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass,function"<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"<br />
}<br />
]<br />
<br />
=== Работа с регулярными выражениями ===<br />
Фильтрация по сложным паттернам путей. В данном случае будут пропущены маркеры, которые НЕ находятся в <code>/.build/builtins</code>, а также у них расширение не <code>c, cpp, h, hpp</code> (то есть оставляем только те маркеры, которые находятся в папке <code>/.build/builtins</code> с расширением <code>c, cpp, h, hpp</code>). В данном случае мы дважды экранируем: сначала слэш, а потом точку.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "nregex(file, \"^/\\\\.build/builtins/.*\\\\.(c|cpp|h|hpp)$\")"<br />
}<br />
]<br />
В результате у нас остаются только подходящие маркеры:<br />
[[File:Edit-markers-8.png|center|thumb|979x979px]]<br />
<br />
== Дополнительные опции ==<br />
<br />
=== Сохранение отредактированного снимка ===<br />
При импорте снимка можно сохранить результат применения правил:<br />
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...<br />
Обязательно должно быть расширение <code>.snap</code> для сохранения.<br />
<br />
== Важные замечания ==<br />
<br />
# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле<br />
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей<br />
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code><br />
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)<br />
# '''Поле line в change''' — должно быть строкой с неотрицательным числом<br />
# '''Поле warnclass в change''' — может принимать только русские, английский буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Bash.zip&diff=3317File:Bash.zip2025-11-17T15:39:23Z<p>Gribunin: bash snapshot</p>
<hr />
<div>== Summary ==<br />
bash snapshot</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Edit_markers_(command_line)&diff=3316Edit markers (command line)2025-11-17T15:37:56Z<p>Gribunin: /* Работа с регулярными выражениями */</p>
<hr />
<div>== Обзор ==<br />
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:<br />
<br />
* '''skip''' — пропуск (удаление) маркеров, соответствующих условию<br />
* '''change''' — изменение полей маркеров<br />
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяется трасса и остается только один (случайный) маркер с объединенной трассой, остальные маркеры удаляются.<br />
Все операции происходят на стороне клиента до загрузки данных на сервер. При импорте результатов Svace, а также sarif (без указания флага --upload) изменяется .svacer-dir. Директория .svace-dir остается неизменной. Снимок остается неизменным при импорте.<br />
<br />
== Использование ==<br />
<br />
=== Импорт результатов Svace ===<br />
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила редактирования к маркерам при импорте результатов анализа Svace.<br />
<br />
=== Импорт SARIF ===<br />
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при импорте SARIF-файлов.<br />
<br />
=== Импорт снимка с редактированием ===<br />
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила к снимку при импорте. Дополнительно можно сохранить отредактированный снимок:<br />
<br />
<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code><br />
<br />
== Формат файла правил ==<br />
Правила задаются в виде JSON-файла, содержащего массив объектов правил:<br />
[<br />
{<br />
"action": "тип_действия",<br />
"rules": "условие_или_список_полей",<br />
"change": { /* только для action: "change" */ }<br />
},<br />
...<br />
]<br />
<br />
=== Типы действий ===<br />
<br />
==== skip — Пропуск маркеров ====<br />
Удаляет маркеры, соответствующие условию.<br />
...<br />
{<br />
"action": "skip",<br />
"rules": "file == 'test.cpp' and line > 100"<br />
}<br />
...<br />
<br />
==== change — Изменение маркеров ====<br />
Изменяет указанные поля маркеров.<br />
...<br />
{<br />
<nowiki> </nowiki>"action": "change",<br />
<nowiki> </nowiki>"rules": "warnclass == 'UNREACHABLE_CODE'",<br />
<nowiki> </nowiki>"change": {<br />
<nowiki> </nowiki> "warnclass": "IGNORED",<br />
<nowiki> </nowiki> "msg": "Код помечен как недостижимый"<br />
<nowiki> </nowiki>}<br />
}<br />
...<br />
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.<br />
<br />
==== deduplicate — Дедупликация ====<br />
Объединяет маркеры с одинаковыми значениями указанных полей. Один маркер выбирается случайно, все trace от остальных маркеров добавляются к нему.<br />
...<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
...<br />
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.<br />
<br />
== Доступные поля и операторы ==<br />
<br />
=== Поля маркеров ===<br />
В условиях можно использовать следующие поля:<br />
<br />
* <code>file</code> — полный путь к файлу (строка)<br />
* <code>line</code> — номер строки (число)<br />
* <code>function</code> — имя функции (строка)<br />
* <code>warnclass</code> — класс предупреждения (строка)<br />
* <code>lang</code> — язык программирования (строка)<br />
* <code>tool</code> — инструмент анализа (строка)<br />
* <code>mtid</code> — ID типа маркера (строка)<br />
* <code>msg</code> — сообщение маркера (строка)<br />
* <code>details</code> — детали маркера (строка)<br />
<br />
=== Операторы сравнения ===<br />
<br />
* <code>==</code>, <code>!=</code> — равно, не равно<br />
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел<br />
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы<br />
* <code>not</code>, <code>!</code> — логическое НЕ<br />
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)<br />
* <code>contains</code> — проверка вхождения подстроки<br />
<br />
=== Функции для работы со строками ===<br />
<br />
* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)<br />
* <code>hasPrefix(s, prefix)</code> — начинается с префикса<br />
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом<br />
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра<br />
* <code>lower(s)</code> — преобразование в нижний регистр<br />
* <code>upper(s)</code> — преобразование в верхний регистр<br />
* <code>trim(s)</code> — удаление пробелов в начале и конце строки<br />
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки<br />
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению<br />
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению<br />
<br />
== Примеры ==<br />
Все примеры используют снимок bash. Детекторы в данном снимке выглядят так:<br />
[[File:Edit-markers-1.png|center|thumb|967x967px]]<br />
<br />
=== Пропуск файлов ===<br />
В данном примере будут пропущены все файлы, которые находятся в папке <code>/.build/lib</code><br />
[<br />
{<br />
"action": "skip",<br />
"rules": "file contains '/.build/lib'"<br />
}<br />
]<br />
Сравнивая исходный снимок и снимок, где было применено edit-markers можно увидеть 215 пропущенных детекторов. Все они находятся в папке <code>/.build/lib</code><br />
[[File:Edit-markers-2.png|center|thumb|983x983px]]<br />
Если необходимо указать название не зависимо от регистра, то можно использовать функцию <code>icontains</code>:<br />
<br />
<code>[ { "action": "skip", "rules": "icontains(file, '/.build/lib')" } ]</code><br />
<br />
=== Изменение класса предупреждений ===<br />
При необходимости возможно изменение полей маркера. В данном примере изменим warnclass маркеров у которых в названии есть <code>UNREACHABLE_CODE</code> и находящиеся после 1000 строки, но детектор <code>UNREACHABLE_CODE</code> изменять не будем.<br />
[<br />
{<br />
"action": "change",<br />
"rules": "warnclass contains 'UNREACHABLE_CODE' and line > 1000",<br />
"change": {<br />
"warnclass": "UNREACHABLE",<br />
"msg": "Изменено правилами edit markers"<br />
}<br />
}<br />
]<br />
[[File:Edit-markers-3.png|center|thumb|955x955px]]<br />
Указанные маркеры изменили свой детектор и описание. <br />
<br />
'''Серьезность, Надежность и CWE привязаны к названию warnclass (детектора), поэтому, если указать''' '''несуществующий warnclass, то данные поля пропадут.'''<br />
<br />
=== Удаление дубликатов ===<br />
Если необходимо объединить несколько детекторов в один по одинаковым полям, то возможно сделать следующее действие (в качестве полей rules можно указать 8 возможных значений, см. описание deduplicate):<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,warnclass"<br />
}<br />
]<br />
Тогда все маркеры, которые находятся в одном файле и с одним warnclass объединятся в один (случайным образом выберется один) и у него будет объединенный trace всех остальным маркеров.<br />
[[File:Edit-markers-4.png|center|thumb|961x961px]]<br />
Для данного примера видно, что все маркеры из файла <code>/.build/alias.c</code> объединились в один (так как у них был один warnclass) и их trace содержит все записи других маркеров. Аналогично произошло и с остальными маркерами, которые находились в одном файле и имели одинаковые warnclass.<br />
<br />
=== Комплексный пример ===<br />
В данном примере пропускаются все маркеры, у которых инструмент равен <code>CSA</code>, а маркеры, которые имеют детекторы <code>'BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'</code> или имеют в описании подстроку <code>unsafe</code> в любом регистре, меняют детектор и описание.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "tool == 'CSA'"<br />
},<br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'] or icontains(msg, 'unsafe')",<br />
"change": {<br />
"warnclass": "HIGH_PRIORITY",<br />
"msg": "Высокоприоритетное предупреждение"<br />
}<br />
}<br />
]<br />
При сравнении с исходным снимком можно заметить, что 91 предупреждение, у которых инструмент был <code>CSA</code> удалены из измененного снимка.<br />
[[File:Edit-markers-5.png|center|thumb|979x979px]]<br />
Также были изменены маркеры, в соответствии с правилами.<br />
[[File:Edit-markers-51.png|center|thumb|980x980px]]<br />
<br />
=== Изменение приоритета для определенных классов ===<br />
Изменение детекторов:<br />
[ <br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['UNREACHABLE_CODE.TERMINATION', 'UNREACHABLE_CODE.RET', 'UNREACHABLE_CODE.ENUM']",<br />
"change": {<br />
"warnclass": "UNREACHABLE_CODE"<br />
}<br />
}<br />
]<br />
<br />
=== Обработка сгенерированных файлов ===<br />
Пропускаем все маркеры в сгенерированных файлах:<br />
<br />
[ <br />
{<br />
"action": "skip",<br />
"rules": "file contains 'generated' or hasPrefix(file, 'vendor/')"<br />
}<br />
]<br />
<br />
=== Дедупликация с последующей фильтрацией ===<br />
Сначала объединяем дубликаты, потом удаляем ненужные:<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass,function"<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"<br />
}<br />
]<br />
<br />
=== Работа с регулярными выражениями ===<br />
Фильтрация по сложным паттернам путей. В данном случае будут пропущены маркеры, которые НЕ находятся в <code>/.build/builtins</code>, а также у них расширение не <code>c, cpp, h, hpp</code> (то есть оставляем только те маркеры, которые находятся в папке <code>/.build/builtins</code> с расширением <code>c, cpp, h, hpp</code>). В данном случае мы дважды экранируем: сначала слэш, а потом точку.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "nregex(file, \"^/\\\\.build/builtins/.*\\\\.(c|cpp|h|hpp)$\")"<br />
}<br />
]<br />
В результате у нас остаются только подходящие маркеры:<br />
[[File:Edit-markers-8.png|center|thumb|979x979px]]<br />
<br />
== Дополнительные опции ==<br />
<br />
=== Сохранение отредактированного снимка ===<br />
При импорте снимка можно сохранить результат применения правил:<br />
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...<br />
Обязательно должно быть расширение <code>.snap</code> для сохранения.<br />
<br />
== Важные замечания ==<br />
<br />
# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле<br />
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей<br />
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code><br />
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)<br />
# '''Поле line в change''' — должно быть строкой с неотрицательным числом<br />
# '''Поле warnclass в change''' — может принимать только русские, английский буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Edit_markers_(command_line)&diff=3315Edit markers (command line)2025-11-17T15:37:36Z<p>Gribunin: /* Работа с регулярными выражениями */</p>
<hr />
<div>== Обзор ==<br />
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:<br />
<br />
* '''skip''' — пропуск (удаление) маркеров, соответствующих условию<br />
* '''change''' — изменение полей маркеров<br />
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяется трасса и остается только один (случайный) маркер с объединенной трассой, остальные маркеры удаляются.<br />
Все операции происходят на стороне клиента до загрузки данных на сервер. При импорте результатов Svace, а также sarif (без указания флага --upload) изменяется .svacer-dir. Директория .svace-dir остается неизменной. Снимок остается неизменным при импорте.<br />
<br />
== Использование ==<br />
<br />
=== Импорт результатов Svace ===<br />
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила редактирования к маркерам при импорте результатов анализа Svace.<br />
<br />
=== Импорт SARIF ===<br />
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при импорте SARIF-файлов.<br />
<br />
=== Импорт снимка с редактированием ===<br />
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила к снимку при импорте. Дополнительно можно сохранить отредактированный снимок:<br />
<br />
<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code><br />
<br />
== Формат файла правил ==<br />
Правила задаются в виде JSON-файла, содержащего массив объектов правил:<br />
[<br />
{<br />
"action": "тип_действия",<br />
"rules": "условие_или_список_полей",<br />
"change": { /* только для action: "change" */ }<br />
},<br />
...<br />
]<br />
<br />
=== Типы действий ===<br />
<br />
==== skip — Пропуск маркеров ====<br />
Удаляет маркеры, соответствующие условию.<br />
...<br />
{<br />
"action": "skip",<br />
"rules": "file == 'test.cpp' and line > 100"<br />
}<br />
...<br />
<br />
==== change — Изменение маркеров ====<br />
Изменяет указанные поля маркеров.<br />
...<br />
{<br />
<nowiki> </nowiki>"action": "change",<br />
<nowiki> </nowiki>"rules": "warnclass == 'UNREACHABLE_CODE'",<br />
<nowiki> </nowiki>"change": {<br />
<nowiki> </nowiki> "warnclass": "IGNORED",<br />
<nowiki> </nowiki> "msg": "Код помечен как недостижимый"<br />
<nowiki> </nowiki>}<br />
}<br />
...<br />
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.<br />
<br />
==== deduplicate — Дедупликация ====<br />
Объединяет маркеры с одинаковыми значениями указанных полей. Один маркер выбирается случайно, все trace от остальных маркеров добавляются к нему.<br />
...<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
...<br />
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.<br />
<br />
== Доступные поля и операторы ==<br />
<br />
=== Поля маркеров ===<br />
В условиях можно использовать следующие поля:<br />
<br />
* <code>file</code> — полный путь к файлу (строка)<br />
* <code>line</code> — номер строки (число)<br />
* <code>function</code> — имя функции (строка)<br />
* <code>warnclass</code> — класс предупреждения (строка)<br />
* <code>lang</code> — язык программирования (строка)<br />
* <code>tool</code> — инструмент анализа (строка)<br />
* <code>mtid</code> — ID типа маркера (строка)<br />
* <code>msg</code> — сообщение маркера (строка)<br />
* <code>details</code> — детали маркера (строка)<br />
<br />
=== Операторы сравнения ===<br />
<br />
* <code>==</code>, <code>!=</code> — равно, не равно<br />
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел<br />
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы<br />
* <code>not</code>, <code>!</code> — логическое НЕ<br />
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)<br />
* <code>contains</code> — проверка вхождения подстроки<br />
<br />
=== Функции для работы со строками ===<br />
<br />
* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)<br />
* <code>hasPrefix(s, prefix)</code> — начинается с префикса<br />
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом<br />
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра<br />
* <code>lower(s)</code> — преобразование в нижний регистр<br />
* <code>upper(s)</code> — преобразование в верхний регистр<br />
* <code>trim(s)</code> — удаление пробелов в начале и конце строки<br />
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки<br />
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению<br />
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению<br />
<br />
== Примеры ==<br />
Все примеры используют снимок bash. Детекторы в данном снимке выглядят так:<br />
[[File:Edit-markers-1.png|center|thumb|967x967px]]<br />
<br />
=== Пропуск файлов ===<br />
В данном примере будут пропущены все файлы, которые находятся в папке <code>/.build/lib</code><br />
[<br />
{<br />
"action": "skip",<br />
"rules": "file contains '/.build/lib'"<br />
}<br />
]<br />
Сравнивая исходный снимок и снимок, где было применено edit-markers можно увидеть 215 пропущенных детекторов. Все они находятся в папке <code>/.build/lib</code><br />
[[File:Edit-markers-2.png|center|thumb|983x983px]]<br />
Если необходимо указать название не зависимо от регистра, то можно использовать функцию <code>icontains</code>:<br />
<br />
<code>[ { "action": "skip", "rules": "icontains(file, '/.build/lib')" } ]</code><br />
<br />
=== Изменение класса предупреждений ===<br />
При необходимости возможно изменение полей маркера. В данном примере изменим warnclass маркеров у которых в названии есть <code>UNREACHABLE_CODE</code> и находящиеся после 1000 строки, но детектор <code>UNREACHABLE_CODE</code> изменять не будем.<br />
[<br />
{<br />
"action": "change",<br />
"rules": "warnclass contains 'UNREACHABLE_CODE' and line > 1000",<br />
"change": {<br />
"warnclass": "UNREACHABLE",<br />
"msg": "Изменено правилами edit markers"<br />
}<br />
}<br />
]<br />
[[File:Edit-markers-3.png|center|thumb|955x955px]]<br />
Указанные маркеры изменили свой детектор и описание. <br />
<br />
'''Серьезность, Надежность и CWE привязаны к названию warnclass (детектора), поэтому, если указать''' '''несуществующий warnclass, то данные поля пропадут.'''<br />
<br />
=== Удаление дубликатов ===<br />
Если необходимо объединить несколько детекторов в один по одинаковым полям, то возможно сделать следующее действие (в качестве полей rules можно указать 8 возможных значений, см. описание deduplicate):<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,warnclass"<br />
}<br />
]<br />
Тогда все маркеры, которые находятся в одном файле и с одним warnclass объединятся в один (случайным образом выберется один) и у него будет объединенный trace всех остальным маркеров.<br />
[[File:Edit-markers-4.png|center|thumb|961x961px]]<br />
Для данного примера видно, что все маркеры из файла <code>/.build/alias.c</code> объединились в один (так как у них был один warnclass) и их trace содержит все записи других маркеров. Аналогично произошло и с остальными маркерами, которые находились в одном файле и имели одинаковые warnclass.<br />
<br />
=== Комплексный пример ===<br />
В данном примере пропускаются все маркеры, у которых инструмент равен <code>CSA</code>, а маркеры, которые имеют детекторы <code>'BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'</code> или имеют в описании подстроку <code>unsafe</code> в любом регистре, меняют детектор и описание.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "tool == 'CSA'"<br />
},<br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'] or icontains(msg, 'unsafe')",<br />
"change": {<br />
"warnclass": "HIGH_PRIORITY",<br />
"msg": "Высокоприоритетное предупреждение"<br />
}<br />
}<br />
]<br />
При сравнении с исходным снимком можно заметить, что 91 предупреждение, у которых инструмент был <code>CSA</code> удалены из измененного снимка.<br />
[[File:Edit-markers-5.png|center|thumb|979x979px]]<br />
Также были изменены маркеры, в соответствии с правилами.<br />
[[File:Edit-markers-51.png|center|thumb|980x980px]]<br />
<br />
=== Изменение приоритета для определенных классов ===<br />
Изменение детекторов:<br />
[ <br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['UNREACHABLE_CODE.TERMINATION', 'UNREACHABLE_CODE.RET', 'UNREACHABLE_CODE.ENUM']",<br />
"change": {<br />
"warnclass": "UNREACHABLE_CODE"<br />
}<br />
}<br />
]<br />
<br />
=== Обработка сгенерированных файлов ===<br />
Пропускаем все маркеры в сгенерированных файлах:<br />
<br />
[ <br />
{<br />
"action": "skip",<br />
"rules": "file contains 'generated' or hasPrefix(file, 'vendor/')"<br />
}<br />
]<br />
<br />
=== Дедупликация с последующей фильтрацией ===<br />
Сначала объединяем дубликаты, потом удаляем ненужные:<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass,function"<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"<br />
}<br />
]<br />
<br />
=== Работа с регулярными выражениями ===<br />
Фильтрация по сложным паттернам путей. В данном случае будут пропущены маркеры, которые НЕ находятся в <code>/.build/builtins</code>, а также у них расширение не <code>c, cpp, h, hpp</code> (то есть оставляем только те маркеры, которые находятся в папке <code>/.build/builtins</code> с расширением <code>c, cpp, h, hpp</code>. В данном случае мы дважды экранируем: сначала слэш, а потом точку.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "nregex(file, \"^/\\\\.build/builtins/.*\\\\.(c|cpp|h|hpp)$\")"<br />
}<br />
]<br />
В результате у нас остаются только подходящие маркеры:<br />
[[File:Edit-markers-8.png|center|thumb|979x979px]]<br />
<br />
== Дополнительные опции ==<br />
<br />
=== Сохранение отредактированного снимка ===<br />
При импорте снимка можно сохранить результат применения правил:<br />
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...<br />
Обязательно должно быть расширение <code>.snap</code> для сохранения.<br />
<br />
== Важные замечания ==<br />
<br />
# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле<br />
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей<br />
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code><br />
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)<br />
# '''Поле line в change''' — должно быть строкой с неотрицательным числом<br />
# '''Поле warnclass в change''' — может принимать только русские, английский буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Edit-markers-8.png&diff=3314File:Edit-markers-8.png2025-11-17T15:37:17Z<p>Gribunin: </p>
<hr />
<div>edit-markers-8</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Edit_markers_(command_line)&diff=3313Edit markers (command line)2025-11-17T15:36:57Z<p>Gribunin: /* Примеры */ edit-markers</p>
<hr />
<div>== Обзор ==<br />
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:<br />
<br />
* '''skip''' — пропуск (удаление) маркеров, соответствующих условию<br />
* '''change''' — изменение полей маркеров<br />
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяется трасса и остается только один (случайный) маркер с объединенной трассой, остальные маркеры удаляются.<br />
Все операции происходят на стороне клиента до загрузки данных на сервер. При импорте результатов Svace, а также sarif (без указания флага --upload) изменяется .svacer-dir. Директория .svace-dir остается неизменной. Снимок остается неизменным при импорте.<br />
<br />
== Использование ==<br />
<br />
=== Импорт результатов Svace ===<br />
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила редактирования к маркерам при импорте результатов анализа Svace.<br />
<br />
=== Импорт SARIF ===<br />
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при импорте SARIF-файлов.<br />
<br />
=== Импорт снимка с редактированием ===<br />
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила к снимку при импорте. Дополнительно можно сохранить отредактированный снимок:<br />
<br />
<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code><br />
<br />
== Формат файла правил ==<br />
Правила задаются в виде JSON-файла, содержащего массив объектов правил:<br />
[<br />
{<br />
"action": "тип_действия",<br />
"rules": "условие_или_список_полей",<br />
"change": { /* только для action: "change" */ }<br />
},<br />
...<br />
]<br />
<br />
=== Типы действий ===<br />
<br />
==== skip — Пропуск маркеров ====<br />
Удаляет маркеры, соответствующие условию.<br />
...<br />
{<br />
"action": "skip",<br />
"rules": "file == 'test.cpp' and line > 100"<br />
}<br />
...<br />
<br />
==== change — Изменение маркеров ====<br />
Изменяет указанные поля маркеров.<br />
...<br />
{<br />
<nowiki> </nowiki>"action": "change",<br />
<nowiki> </nowiki>"rules": "warnclass == 'UNREACHABLE_CODE'",<br />
<nowiki> </nowiki>"change": {<br />
<nowiki> </nowiki> "warnclass": "IGNORED",<br />
<nowiki> </nowiki> "msg": "Код помечен как недостижимый"<br />
<nowiki> </nowiki>}<br />
}<br />
...<br />
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.<br />
<br />
==== deduplicate — Дедупликация ====<br />
Объединяет маркеры с одинаковыми значениями указанных полей. Один маркер выбирается случайно, все trace от остальных маркеров добавляются к нему.<br />
...<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
...<br />
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.<br />
<br />
== Доступные поля и операторы ==<br />
<br />
=== Поля маркеров ===<br />
В условиях можно использовать следующие поля:<br />
<br />
* <code>file</code> — полный путь к файлу (строка)<br />
* <code>line</code> — номер строки (число)<br />
* <code>function</code> — имя функции (строка)<br />
* <code>warnclass</code> — класс предупреждения (строка)<br />
* <code>lang</code> — язык программирования (строка)<br />
* <code>tool</code> — инструмент анализа (строка)<br />
* <code>mtid</code> — ID типа маркера (строка)<br />
* <code>msg</code> — сообщение маркера (строка)<br />
* <code>details</code> — детали маркера (строка)<br />
<br />
=== Операторы сравнения ===<br />
<br />
* <code>==</code>, <code>!=</code> — равно, не равно<br />
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел<br />
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы<br />
* <code>not</code>, <code>!</code> — логическое НЕ<br />
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)<br />
* <code>contains</code> — проверка вхождения подстроки<br />
<br />
=== Функции для работы со строками ===<br />
<br />
* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)<br />
* <code>hasPrefix(s, prefix)</code> — начинается с префикса<br />
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом<br />
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра<br />
* <code>lower(s)</code> — преобразование в нижний регистр<br />
* <code>upper(s)</code> — преобразование в верхний регистр<br />
* <code>trim(s)</code> — удаление пробелов в начале и конце строки<br />
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки<br />
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению<br />
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению<br />
<br />
== Примеры ==<br />
Все примеры используют снимок bash. Детекторы в данном снимке выглядят так:<br />
[[File:Edit-markers-1.png|center|thumb|967x967px]]<br />
<br />
=== Пропуск файлов ===<br />
В данном примере будут пропущены все файлы, которые находятся в папке <code>/.build/lib</code><br />
[<br />
{<br />
"action": "skip",<br />
"rules": "file contains '/.build/lib'"<br />
}<br />
]<br />
Сравнивая исходный снимок и снимок, где было применено edit-markers можно увидеть 215 пропущенных детекторов. Все они находятся в папке <code>/.build/lib</code><br />
[[File:Edit-markers-2.png|center|thumb|983x983px]]<br />
Если необходимо указать название не зависимо от регистра, то можно использовать функцию <code>icontains</code>:<br />
<br />
<code>[ { "action": "skip", "rules": "icontains(file, '/.build/lib')" } ]</code><br />
<br />
=== Изменение класса предупреждений ===<br />
При необходимости возможно изменение полей маркера. В данном примере изменим warnclass маркеров у которых в названии есть <code>UNREACHABLE_CODE</code> и находящиеся после 1000 строки, но детектор <code>UNREACHABLE_CODE</code> изменять не будем.<br />
[<br />
{<br />
"action": "change",<br />
"rules": "warnclass contains 'UNREACHABLE_CODE' and line > 1000",<br />
"change": {<br />
"warnclass": "UNREACHABLE",<br />
"msg": "Изменено правилами edit markers"<br />
}<br />
}<br />
]<br />
[[File:Edit-markers-3.png|center|thumb|955x955px]]<br />
Указанные маркеры изменили свой детектор и описание. <br />
<br />
'''Серьезность, Надежность и CWE привязаны к названию warnclass (детектора), поэтому, если указать''' '''несуществующий warnclass, то данные поля пропадут.'''<br />
<br />
=== Удаление дубликатов ===<br />
Если необходимо объединить несколько детекторов в один по одинаковым полям, то возможно сделать следующее действие (в качестве полей rules можно указать 8 возможных значений, см. описание deduplicate):<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,warnclass"<br />
}<br />
]<br />
Тогда все маркеры, которые находятся в одном файле и с одним warnclass объединятся в один (случайным образом выберется один) и у него будет объединенный trace всех остальным маркеров.<br />
[[File:Edit-markers-4.png|center|thumb|961x961px]]<br />
Для данного примера видно, что все маркеры из файла <code>/.build/alias.c</code> объединились в один (так как у них был один warnclass) и их trace содержит все записи других маркеров. Аналогично произошло и с остальными маркерами, которые находились в одном файле и имели одинаковые warnclass.<br />
<br />
=== Комплексный пример ===<br />
В данном примере пропускаются все маркеры, у которых инструмент равен <code>CSA</code>, а маркеры, которые имеют детекторы <code>'BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'</code> или имеют в описании подстроку <code>unsafe</code> в любом регистре, меняют детектор и описание.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "tool == 'CSA'"<br />
},<br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['BAD_COPY_PASTE', 'DEREF_AFTER_NULL', 'UNUSED_VALUE'] or icontains(msg, 'unsafe')",<br />
"change": {<br />
"warnclass": "HIGH_PRIORITY",<br />
"msg": "Высокоприоритетное предупреждение"<br />
}<br />
}<br />
]<br />
При сравнении с исходным снимком можно заметить, что 91 предупреждение, у которых инструмент был <code>CSA</code> удалены из измененного снимка.<br />
[[File:Edit-markers-5.png|center|thumb|979x979px]]<br />
Также были изменены маркеры, в соответствии с правилами.<br />
[[File:Edit-markers-51.png|center|thumb|980x980px]]<br />
<br />
=== Изменение приоритета для определенных классов ===<br />
Изменение детекторов:<br />
[ <br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['UNREACHABLE_CODE.TERMINATION', 'UNREACHABLE_CODE.RET', 'UNREACHABLE_CODE.ENUM']",<br />
"change": {<br />
"warnclass": "UNREACHABLE_CODE"<br />
}<br />
}<br />
]<br />
<br />
=== Обработка сгенерированных файлов ===<br />
Пропускаем все маркеры в сгенерированных файлах:<br />
<br />
[ <br />
{<br />
"action": "skip",<br />
"rules": "file contains 'generated' or hasPrefix(file, 'vendor/')"<br />
}<br />
]<br />
<br />
=== Дедупликация с последующей фильтрацией ===<br />
Сначала объединяем дубликаты, потом удаляем ненужные:<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass,function"<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"<br />
}<br />
]<br />
<br />
=== Работа с регулярными выражениями ===<br />
Фильтрация по сложным паттернам путей. В данном случае будут пропущены маркеры, которые НЕ находятся в <code>/.build/builtins</code>, а также у них расширение не <code>c, cpp, h, hpp</code> (то есть оставляем только те маркеры, которые находятся в папке <code>/.build/builtins</code> с расширением <code>c, cpp, h, hpp</code>. В данном случае мы дважды экранируем: сначала слэш, а потом точку.<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "nregex(file, \"^/\\\\.build/builtins/.*\\\\.(c|cpp|h|hpp)$\")"<br />
}<br />
]<br />
В результате у нас остаются только подходящие маркеры:<br />
<br />
== Дополнительные опции ==<br />
<br />
=== Сохранение отредактированного снимка ===<br />
При импорте снимка можно сохранить результат применения правил:<br />
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...<br />
Обязательно должно быть расширение <code>.snap</code> для сохранения.<br />
<br />
== Важные замечания ==<br />
<br />
# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле<br />
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей<br />
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code><br />
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)<br />
# '''Поле line в change''' — должно быть строкой с неотрицательным числом<br />
# '''Поле warnclass в change''' — может принимать только русские, английский буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Edit-markers-51.png&diff=3312File:Edit-markers-51.png2025-11-17T15:07:55Z<p>Gribunin: </p>
<hr />
<div>edit-markers-51</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Edit-markers-5.png&diff=3311File:Edit-markers-5.png2025-11-17T15:04:32Z<p>Gribunin: </p>
<hr />
<div>edit-markers-5</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Edit-markers-4.png&diff=3310File:Edit-markers-4.png2025-11-17T14:10:13Z<p>Gribunin: </p>
<hr />
<div>edit-markers-4</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Edit-markers-3.png&diff=3309File:Edit-markers-3.png2025-11-17T14:02:31Z<p>Gribunin: </p>
<hr />
<div>edit-markers-3</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Edit-markers-2.png&diff=3308File:Edit-markers-2.png2025-11-17T13:46:43Z<p>Gribunin: </p>
<hr />
<div>edit-markers-2</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Edit-markers-1.png&diff=3307File:Edit-markers-1.png2025-11-17T13:37:27Z<p>Gribunin: </p>
<hr />
<div>edit-markers-1</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Edit_markers_(command_line)&diff=3306Edit markers (command line)2025-11-14T15:39:50Z<p>Gribunin: edit markers descriptions change</p>
<hr />
<div>== Обзор ==<br />
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:<br />
<br />
* '''skip''' — пропуск (удаление) маркеров, соответствующих условию<br />
* '''change''' — изменение полей маркеров<br />
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяется трасса и остается только один (случайный) маркер с объединенной трассой, остальные маркеры удаляются.<br />
Все операции происходят на стороне клиента до загрузки данных на сервер. При импорте результатов Svace, а также sarif (без указания флага --upload) изменяется .svacer-dir. Директория .svace-dir остается неизменной. Снимок остается неизменным при импорте.<br />
<br />
== Использование ==<br />
<br />
=== Импорт результатов Svace ===<br />
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила редактирования к маркерам при импорте результатов анализа Svace.<br />
<br />
=== Импорт SARIF ===<br />
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при импорте SARIF-файлов.<br />
<br />
=== Импорт снимка с редактированием ===<br />
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила к снимку при импорте. Дополнительно можно сохранить отредактированный снимок:<br />
<br />
<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code><br />
<br />
== Формат файла правил ==<br />
Правила задаются в виде JSON-файла, содержащего массив объектов правил:<br />
[<br />
{<br />
"action": "тип_действия",<br />
"rules": "условие_или_список_полей",<br />
"change": { /* только для action: "change" */ }<br />
},<br />
...<br />
]<br />
<br />
=== Типы действий ===<br />
<br />
==== skip — Пропуск маркеров ====<br />
Удаляет маркеры, соответствующие условию.<br />
...<br />
{<br />
"action": "skip",<br />
"rules": "file == 'test.cpp' and line > 100"<br />
}<br />
...<br />
<br />
==== change — Изменение маркеров ====<br />
Изменяет указанные поля маркеров.<br />
...<br />
{<br />
<nowiki> </nowiki>"action": "change",<br />
<nowiki> </nowiki>"rules": "warnclass == 'UNREACHABLE_CODE'",<br />
<nowiki> </nowiki>"change": {<br />
<nowiki> </nowiki> "warnclass": "IGNORED",<br />
<nowiki> </nowiki> "msg": "Код помечен как недостижимый"<br />
<nowiki> </nowiki>}<br />
}<br />
...<br />
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.<br />
<br />
==== deduplicate — Дедупликация ====<br />
Объединяет маркеры с одинаковыми значениями указанных полей.<br />
...<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
...<br />
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.<br />
<br />
== Доступные поля и операторы ==<br />
<br />
=== Поля маркеров ===<br />
В условиях можно использовать следующие поля:<br />
<br />
* <code>file</code> — путь к файлу (строка)<br />
* <code>line</code> — номер строки (число)<br />
* <code>function</code> — имя функции (строка)<br />
* <code>warnclass</code> — класс предупреждения (строка)<br />
* <code>lang</code> — язык программирования (строка)<br />
* <code>tool</code> — инструмент анализа (строка)<br />
* <code>mtid</code> — ID типа маркера (строка)<br />
* <code>msg</code> — сообщение маркера (строка)<br />
* <code>details</code> — детали маркера (строка)<br />
<br />
=== Операторы сравнения ===<br />
<br />
* <code>==</code>, <code>!=</code> — равно, не равно<br />
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел<br />
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы<br />
* <code>not</code>, <code>!</code> — логическое НЕ<br />
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)<br />
* <code>contains</code> — проверка вхождения подстроки<br />
<br />
=== Функции для работы со строками ===<br />
<br />
* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)<br />
* <code>hasPrefix(s, prefix)</code> — начинается с префикса<br />
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом<br />
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра<br />
* <code>lower(s)</code> — преобразование в нижний регистр<br />
* <code>upper(s)</code> — преобразование в верхний регистр<br />
* <code>trim(s)</code> — удаление пробелов в начале и конце строки<br />
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки<br />
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению<br />
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению<br />
<br />
== Примеры ==<br />
<br />
=== Пропуск тестовых файлов ===<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'test') or icontains(file, 'spec')"<br />
}<br />
]<br />
<br />
=== Изменение класса предупреждений ===<br />
[<br />
{<br />
"action": "change",<br />
"rules": "warnclass == 'UNREACHABLE_CODE' and icontains(file, 'generated')",<br />
"change": {<br />
"warnclass": "INFO",<br />
"msg": "Недостижимый код в сгенерированном файле"<br />
}<br />
}<br />
]<br />
<br />
=== Удаление дубликатов ===<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
]<br />
<br />
=== Комплексный пример ===<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "file == '.build/src/generated.c'"<br />
},<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,function"<br />
},<br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['DEBUG', 'TRACE', 'INFO'] and line > 1000",<br />
"change": {<br />
"warnclass": "LOW_PRIORITY",<br />
"msg": "Низкоприоритетное предупреждение в длинном файле"<br />
}<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "regex(file, \".*_test\\\\.(c|cpp)$\")"<br />
}<br />
]<br />
<br />
=== Изменение приоритета для определенных классов ===<br />
Понижаем приоритет информационных сообщений:<br />
[ <br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['UNREACHABLE_CODE.ENUM', 'UNREACHABLE_CODE.RET', 'UNUSED_VALUE.PARAM_ASSIGN']",<br />
"change": {<br />
"warnclass": "UNREACHABLE_CODE"<br />
}<br />
}<br />
]<br />
<br />
=== Обработка сгенерированных файлов ===<br />
Пропускаем все маркеры в сгенерированных файлах:<br />
<br />
[ <br />
{<br />
"action": "skip",<br />
"rules": "contains(file, 'generated') or contains(file, '.build') or hasPrefix(file, 'vendor/')"<br />
}<br />
]<br />
<br />
=== Дедупликация с последующей фильтрацией ===<br />
Сначала объединяем дубликаты, потом удаляем ненужные:<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass,function"<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"<br />
}<br />
]<br />
<br />
=== Работа с регулярными выражениями ===<br />
Фильтрация по сложным паттернам путей:<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "regex(file, \"^(tests?|spec|mock|stub)/.*$\") or nregex(file, \"^src/.*\\.(c|cpp|h|hpp)$\")"<br />
}<br />
]<br />
<br />
== Дополнительные опции ==<br />
<br />
=== Сохранение отредактированного снимка ===<br />
При импорте снимка можно сохранить результат применения правил:<br />
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...<br />
Обязательно должно быть расширение <code>.snap</code> для сохранения.<br />
<br />
== Важные замечания ==<br />
<br />
# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле<br />
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей<br />
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code><br />
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)<br />
# '''Поле line в change''' — должно быть строкой с неотрицательным числом<br />
# '''Поле warnclass в change''' — может принимать только русские, английский буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Changelog&diff=3303Changelog2025-11-13T14:30:00Z<p>Gribunin: changelog 12</p>
<hr />
<div>=== Release 12-0-0 ===<br />
December?<br />
<br />
* Упростили [[Help:XSvacer:AIAssistant:Deploy|деплой ИИ-ассистента]]: добавили его сервис в docker-compose и deb/rpm пакеты<br />
* Расширили возможности конфигурации при запуске сервера через [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose]: теперь можно включить debug, указать конфиг LDAP и параметр public-url<br />
* Добавлена возможность указания минимального количества снимков, которое необходимо оставлять в ветке, тип очистки и период удаления в [[Help:CLI/cleanup|автоматическом удалении снимков]]<br />
* Добавлена возможность [[Edit markers (command line)|автоматически обрабатывать маркеры]] при импорте данных. Также обработка маркеров доступна через [[Help:UI manual#Работа со снимками|UI]]<br />
* Добавлен флаг <code>diff-url</code> для команды <code>quickdiff</code> в CLI, также как и для команд <code>import</code>, <code>upload</code>, <code>sarif2 import</code> с указанием опции quick-stat. Данный флаг позволяет получать ссылку на diff снимков<br />
* Добавлены предупреждения если в командах <code>import</code>, <code>sarif2 import</code> используются флаги, которые используются флагом <code>upload</code>, но флаг <code>upload</code> не установлен<br />
<br />
=== Release 11-2-0 ===<br />
22.07.2025<br />
<br />
* Исправлены зависания сервера<br />
* Добавлено автоматическое удаление архивов и прочих временных файлов при импорте .svace-dir и SARIF-файлов через REST API<br />
<br />
=== Release 11-1-0 ===<br />
08.07.2025<br />
<br />
* Команды <code>--project-group, --if-no-group, --autoclean, --autoclean-svace</code> можно использовать в REST API для импорта svace-dir<br />
* При использовании REST API для импорта svace-dir сервер будет автоматически удалять директории <code>.svace-dir</code> и <code>.svacer</code> если не указаны явные опции <code>--autoclean=false, --autoclean-svace=false</code><br />
* Добавлена опция запуска сервера <code>--classic-inv-mode</code> для включения режима совместимости по генерации инвариантов с версией <= 8.x.x<br />
* Исправлены ошибки в работе <code>--quality-gate</code>, добавлена возможность учета статусов разметки. Добавлена возможность [[Help:Import from Svace#Флаг --baseline|указания baseline]] для сравнений при использовании опции <code>--quality-gate</code><br />
* Исправлены ошибки при подключении к PostgreSQL в SSL-режиме<br />
* Исправлен ряд ошибок при работе с LDAP<br />
* Команда <code>quickdiff</code> в CLI теперь выдает информацию также о Same и Matched предупреждениях<br />
<br />
=== Release 11-0-0 ===<br />
19.05.2025<br />
<br />
* Убраны излишние сообщения в логе сервера о login/logout операциях. Они будут выводиться только при запуске сервера с опцией <code>--debug</code><br />
* Команды CLI <code>svacer sarif *</code> были убраны, для [[Help:Sarif|импорта и экспорта]] следует использовать <code>svacer sarif2 *</code><br />
* Экспорт SARIF теперь включает все комментарии как отдельные объекты в <code>Properties</code><br />
* При экспорте в SARIF теперь экспортируются поля <code>Labels, Orig function</code><br />
* Импорт SARIF теперь корректным образом учитывает relatedLocations и формирует трассу<br />
* Импорт SARIF теперь автоматически импортирует исходники, если они включены в сам SARIF файл<br />
* Добавлена возможность указания [[Help:Sarif#Мэппинг severity|мэппинга severity]] детекторов при импорте из SARIF<br />
* Добавлен механизм указания правил резолвинга путей при импортировании исходного кода вместе с SARIF файлом<br />
* Экспорт исходников из снимка будет доступен только при наличии исходников на сервере<br />
* Добавлены флаги <code>--autoclean</code>, <code>--autoclean-svace</code> в команду <code>svacer import</code> для автоматического удаления <code>.svace-dir / .svacer-dir</code> после успешного импорта и загрузки данных на сервер<br />
* Улучшена поддержка [[OIDC]]<br />
* Улучшена поддержка [[LDAP configuration|LDAP]]<br />
* Добавлена интеграция с хранилищем секретов [[Infisical]]<br />
* Добавлена [[Notifications|служба нотификаций]] пользователей через почтовые сообщения и мессенджер telegram<br />
* Добавлен механизм аутентификации и [[Help:UI manual#Управление токенами доступа|управления]] персональными токенами доступа<br />
* Добавлен механизм упоминания пользователей через специальную конструкцию @login в комментариях к разметке<br />
* В разделе Статистика добавлен дашборд с [[Release notes 11-0-0#Изменения в разделе Статистика|Общей статистикой]], содержащей метрики по последним импортированным снимкам в ветках проектов<br />
* В статистике по активности пользователей добавлена возможность просмотра панели с актуальной информацией о маркере и опция показа только действий с актуальной разметкой<br />
* Большинство CLI команд, работающих с сервером, теперь делают явный logout после завершения<br />
* Svacer при импорте результатов Svace автоматически импортирует файлы <code>*.warn, *.err</code> с предупреждениями от самого анализатора Svace. Автоматический импорт не будет происходить при размере этих файлов более 30Мб (большой размер может свидетельствовать о проблемах в ходе анализа)<br />
* Переменная окружения <code>SVACER_CACHE_DIR</code> теперь учитывается во всех местах (ранее в ряде случаев мог неявно использоваться <code>$HOME/.cache</code>)<br />
* Добавлена возможность [[Help:CLI/cleanup|автоматического удаления снимков]]<br />
<br />
=== Release 10-0-1 ===<br />
17.02.2025<br />
<br />
* Исправлена ошибка с временной таблицей при обработке планов автомиграции разметки при импорте результатов (ERROR: relation "loaded_review" already exists)<br />
<br />
=== Release 10-0-0 ===<br />
16.01.2025<br />
<br />
* Множество изменений в UI, смотрите [[Release notes 10-0-0]]<br />
* Сделали [[Help:Installation#rpm|dnf/yum репозиторий]] для RPM-пакетов Svacer<br />
* Реализована возможность [[Markup2|экспорта, импорта и копирования разметки посредством Public REST API и CLI]]<br />
* Реализован дополнительный экспериментальный механизм [[Help:UI manual#Настройка интерфейса|генерации PDF на основе HTML]]. Генерация PDF переведена на асинхронный режим с показом нотификации пользователю<br />
* Добавлена возможность очистки всей разметки и/или комментариев на ветке проекта<br />
* Улучшения функциональности просмотра маркеров в встроенном IDE Theia<br />
* Добавлена функциональность по [[Help:UI manual#Глобальный поиск|глобальному поиску]] маркеров, комментариев и снимков по различным атрибутам<br />
* Добавлена возможность [[Help:UI manual#Просмотр статистики|получения статистики]] по маркерам и активностям пользователей при разметке<br />
* В API fullmarkers добавлен параметр <code>labels: true/false</code> для выгрузки меток маркера<br />
* Реализован Public API для получения/добавления/удаления меток маркеров<br />
* Настройки LDAP и прочие настройки аутентификации добавлены в единый конфигурационный файл<br />
* Добавлена возможность удаления кода из снимка при частичном импорте в Svacer<br />
* Добавлена опция minVersion, maxVersion для TLS при запуске сервера Svacer<br />
* Добавлена поддержка групп проектов при импорте снимков в CLI<br />
* При импорте снимков реализована поддержка автоматического определения пути префикса для переноса разметки<br />
* Исправлен ряд ошибок в импорте и генерации [[Help:Sarif|SARIF]]<br />
* Исправлены ошибки в копировании разметки между ветками, клонировании проектов и веток<br />
* Добавлена возможность отключения бэкграунд задач по очистке мусора<br />
* Добавлено экспериментальное CLI API для просмотра асинхронных задач на генерацию PDF<br />
* Добавлена возможность визуализации производительности сервера на основе [https://github.com/arl/statsviz statsviz]<br />
* Добавлена поддержка относительных путей в svres файле<br />
* Добавлена возможность ожидания завершения операций по очистки мусора при выполнении операций по импорту результатов анализа<br />
* Добавлена поддержка CWE таксономий при экспорте [[Help:Sarif|SARIF]]<br />
* Добавлена переменная окружения SVACER_TOKEN_LIFETIME для управления временем жизни токена аутентификации<br />
* Добавлена переменная окружения SVACER_RESET_ADMIN_PASSWORD для явного указания желаемого пароля при операции по сбросу пароля администратора<br />
* Добавлен [[Notifications|механизм нотификаций пользователей]] о внутренних событиях Svacer (экспериментальный функционал)<br />
<br />
=== Release 9-0-2 ===<br />
22.07.2024<br />
<br />
* Еще некоторые исправления, связанные с миграцией данных<br />
* Исправлена проблема с навигацией по Go to Definition<br />
<br />
=== Release 9-0-1 ===<br />
15.07.2024<br />
<br />
* Исправлены ошибки в клонировании проектов, приводящие к размножению записей в некоторых внутренних таблицах<br />
* Различные исправления, связанные с миграцией данных<br />
* Исправлена работа ряда CLI команд с включенным TLS на сервере<br />
* Исправлен ряд ошибок в генерации PDF<br />
<br />
=== Release 9-0-0 ===<br />
04.06.2024<br />
<br />
* Множество изменений в UI, смотрите [[Release notes 9-0-0]]<br />
* Svacer разделен на два исполняемых файла: <code>svacer-server</code> — сервер и <code>svacer</code> — клиент<br />
* {{Note}}Object store заменен на другую реализацию. Конвертация данных запускается автоматически при апгрейде и требует примерно 2х-2.2х дискового пространства, после конвертации старый object store будет удален. Время конвертации зависит от объема данных и скорости диска<br />
* {{Note}}Изменен [[Help:Match|алгоритм сопоставления предупреждений]]. При старте сервера будет произведена регенерация всех инвариантов во всех ветках. Это может занять продолжительное время (зависит от мощности сервера и объемов данных)<br />
* Добавлена возможность [[Help:Match#Ручное сопоставление предупреждений (экспериментальная возможность)|ручного сопоставления предупреждений]] для переноса разметки<br />
* Добавлена экспериментальная поддержка [[OIDC|OpenID]] протокола для аутентификации<br />
* Добавлена экспериментальная возможность [[Help:CLI#Слияние снимков из CLI (экспериментальная опция)|слияния снимков через CLI]]<br />
* Исправлены баги в [[Help:Sarif|импорте Sarif]], добавлена поддержка импорта с относительными путями к файлам (флаг <code>--base-dir</code>)<br />
* Лог сервера работает в режиме append, прежние данные не затираются<br />
* Добавлена возможность передачи токена аутентификации в клиент Svacer через переменную окружения <code>SVACER_AUTH_TOKEN=token</code><br />
* Добавлена возможность передачи логина и пароля в клиент Svacer через переменную окружения <code>SVACER_AUTH_CREDS=login:password</code><br />
* Добавлен public REST endpoint для импорта <code>.svace-dir</code> на стороне сервера<br />
* Добавлена возможность импорта <code>.svace-dir</code> из веб-интерфейса<br />
* Добавлены [[Metrics|метрики]] для Prometheus, доступны при запуске сервера с переменной окружения <code>SVACER_TRACE_OPTIONS=prom_metrics_on</code> на <code>/api/metrics</code><br />
* Добавлена очистка БД от мусора с возможностью настройки периодичности данной операции через переменную окружения <code>SVACER_GC_PERIOD=val</code> где val — duration в формате <code>hhmmss</code> или [https://en.wikipedia.org/wiki/Cron Cron]<br />
* Добавлена возможность клонирования проектов<br />
* Добавлен импорт <code>*warn, *.err</code> файлов из <code>.svace-dir</code>, которые содержат диагностические сообщения от Svace<br />
* Добавлена возможность [[Help:CLI#Ограничение числа запросов|ограничения числа запросов]] на сервер с указанием параметров в переменной окружения <code>SVACER_SERVER_THROTTLE_PARAMS</code><br />
* Добавлен шаблон для импорта разметки из кода на Go: <code>DEFAULT_GO</code><br />
* Добавлена возможность [[Help:CLI#Аутентификация из файла|аутентификации из файла]]<br />
* Исправлены проблемы безопасности<br />
* Добавлена возможность просмотра исходного кода снимка с предупреждениями анализатора во внешней IDE собранной на базе [https://theia-ide.org/ Theia IDE]<br />
* К команде automigrate add в CLI добавлен флаг <code>skip-exist</code>, чтобы при добавлении паттерна, который уже существует, не выдавало ошибки <br />
* К команде upload (import с флагом upload) с указанием флага <code>quality-gate</code> теперь можно добавить флаг <code>quality-gate-verbose</code>. Если его указать, то также будет выведен результат успешных проверок quality-gate<br />
* Улучшения в поддержке протокола LDAP<br />
<br />
=== Release 8-0-1 ===<br />
22.01.2024<br />
<br />
* Исправлена работа в изолированной от сети среде. Загрузка Web UI больше не требует доступа к публичным CDN<br />
* Добавлена поддержка функций при указании пользовательского фильтра<br />
* Добавлено API для управления пользовательскими фильтрами. Детали и пример использования можно найти здесь: https://gitlab.ispras.ru/svacer-public/api-go-examples/-/tree/master/api-ui-settings<br />
* Исправлено отображение Checker Severity при экспорте в SARIF. Теперь Critical -> error; Major, Normal -> warning; Minor -> note; any other -> warning<br />
<br />
=== Release 8-0-0 ===<br />
21.11.2023<br />
<br />
* Множество изменений в UI. Смотрите обзор в [[Release notes 8-0-0]]<br />
* Добавлен новый импорт и экспорт из SARIF в command line с поддержкой исходного кода в SARIF файлах и импортом описания детекторов из SARIF<br />
* Добавлены группы проектов<br />
* Переделана модель ролей и доступов. Добавлен CLI для управления ролями и доступами<br />
* Добавлена возможность настройки автопереноса разметки между ветками, в том числе в разных проектах<br />
* Импорт/экспорт снимков включает информацию о детекторах<br />
* Исправлена работа интерфейса с Undefined детекторами (т. е. детекторами, информация о которых отсутствует в Svacer)<br />
* Добавлено экспериментальное API по управлению детекторами и конфигурациями детекторов<br />
* Добавлена очистка исходного кода от Svacer-specific комментариев перед экспортом разметки в код<br />
* Добавлена возможность включения режима обязательного комментария при разметке кода. Комментарий будет сгруппирован с операцией разметки и будет иметь ссылку на нее<br />
* Утилита миграции со старого svace-сервера больше не поддерживается. При необходимости миграции используйте утилиту из прошлых релизов Svacer<br />
* Добавлена Swagger документация на API<br />
* Добавлено хранение истории изменений комментариев<br />
* Опция <code>--pathPrefix</code> поддерживает файлы в JSON формате вида: <code>[{ "prefix": "/some/path", "replace": "/test" }, ...]</code><br />
* При использовании операции по обновлению <code>pathPrefix</code> на сервере, данные о прежнем <code>pathPrefix</code> запоминаются в мета-информации о снимке<br />
* Добавлена возможность переименования снимков в UI<br />
* Sensitive информация (детали подключения к БД с данными аутентификации) убрана из UI и API<br />
* ОС в docker-образе Svacer обновлена с Ubuntu 18 до Ubuntu 22<br />
* Улучшена логика автоопределения портов и протоколов при соединении с сервером из Svacer CLI<br />
<br />
=== Release 7-0-1 ===<br />
23.05.2023<br />
<br />
* Исправлена проблема с фильтрацией предупреждений для C# проектов<br />
<br />
=== Release 7-0-0 ===<br />
16.05.2023<br />
<br />
* Убрана зависимость от PostgreSQL из .deb и .rpm пакетов, чтобы проще было ставить Svacer только как клиент<br />
* Сделан пакет для Windows (.msi) и документация по установке и запуску на Windows<br />
* Теперь, если при svacer import и svacer sarif не указан путь к проекту, им считается текущая директория<br />
* Информация о разметке и блокировках теперь обновляется автоматически при изменении в другом браузере (табе) или другим пользователем<br />
* UI для пользовательских фильтров улучшен и перенесен в правую верхнюю часть экрана<br />
* UI для выбора проекта, ветки и снимка теперь находится на одном уровне<br />
* Улучшен UI для режима сравнения снимков<br />
* Добавлена возможность работать одновременно с несколькими открытыми файлами в режиме Code, это поведение можно изменить в настройках профиля пользователя<br />
* В левой навигационной панели детекторы теперь по умолчанию группируются по серьезности, это поведение можно изменить в настройках профиля пользователя<br />
* Профиль текущего пользователя теперь можно смотреть/редактировать только через меню в правом верхнем углу<br />
* Добавлена возможность копирования в системном логе и журнале<br />
* Для пользователя теперь запоминается последний контекст (проект/ветка/снимок), с которым он работал, он автоматически открывается при старте новой сессии<br />
* Групповая разметка теперь делается единой транзакцией, в случае ошибок или отмены все изменения откатываются<br />
* Добавлено предупреждение при использовании некорректных путей при использовании REST API с префиксом /api<br />
* Поддержка указания паролей из файла или pipe-а при использование Svacer CLI<br />
* Добавлена поддержка multi-tab code view для режима просмотра кода объекта сборки<br />
* Добавлена поддержка сохранения информации об удаленных детекторах при загрузке информации о детекторах из новой версии Svace<br />
* Исправлен импорт результатов анализа, если сборка проводилась с опцией --disable-dxr<br />
* Исправлены проблемы при импорте и прикреплении нескольких файлов к снимку<br />
* Исправлены ошибки с входом в систему пользователей LDAP (специальные символы в пароле, вход по атрибуту mail)<br />
* Добавлена возможность использования резервных серверов LDAP<br />
* Добавлена возможность автоматического назначения пользователям LDAP роли Svacer, в зависимости от принадлежности пользователя к LDAP группе<br />
* Добавлены новые public запросы на получение маркеров/снимков/проектов с учетом заданных параметров фильтрации<br />
* Добавлена поддержка TLS при работе сервера по протоколам HTTP и gRPC<br />
* Добавлена возможность загрузки статистики по общему количеству предупреждений и по количеству размеченных предупреждений для проектов и веток через REST API<br />
* Добавлена вкладка выбора проектов в расширении VSCode<br />
* Убрана возможность использовать всплывающее окно в VScode для добавления/редактирования/удаления комментариев, установки ревью-статусов, локов и т.д.<br />
<br />
=== Release 6-0-3 ===<br />
25.01.2023<br />
<br />
* RPM-пакет теперь при сборке упаковывается в gzip вместо zstd для обратной совместимости со старыми дистрибутивами<br />
* Если short url некорректен, то Svacer теперь будет возвращать корректный http error NotFound<br />
* Если путь к лог файлу явно не указан, то svacer.log будет создаваться во временной директории. Это решает проблемы при запуске Svacer из директорий с запретом на запись. Путь к лог файлу будет печататься в stdout<br />
* Лог файлы не будут создаваться, когда используется опция --help<br />
* Исправлены проблемы при миграции схемы данных, когда в PostgreSQL используется SSL подключение<br />
* Добавлены описания детекторов из последнего релиза Svace, которые были пропущены в релизе 6-0-2<br />
* Исправлена работа Svacer за proxy-сервером, где выставляется Header "X-Content-Type-Options nosniff"<br />
* Добавлены кнопки для скачивания системного лога и журнала из web-интерфейса<br />
* Поправлен ряд ошибок валидации схемы при экспорте в SARIF<br />
* Исправлено поведение при наличии нескольких хуков в конфигурационном файле<br />
* В информацию о маркере для хуков добавлены checker severity и reliability<br />
* Исправлен случайный порядок URL для маркеров при использовании public API для получения URL-ов<br />
* На главную страницу добавлена кнопка "Помощь", которая открывает документацию<br />
* При использовании команд навигации в режиме "Browse code" текущий файл теперь корректно подсвечивается в дереве файлов<br />
* В диалоге групповой разметки убран индикатор изменений в виде кружочка, наличие изменений можно определить по активности кнопок "Apply" и "Reset"<br />
* Кнопка обновления в верхнем меню теперь корректно обновляет информацию на странице Settings/Project<br />
* Различные небольшие исправления в пользовательском интерфейсе<br />
<br />
=== Release 6-0-2 ===<br />
16.12.2022<br />
<br />
* Исправлена проблема в UI с сохраненными пользовательскими фильтрами<br />
<br />
=== Release 6-0-1 === <br />
13.12.2022<br />
<br />
* Добавлено описание ряда детекторов, которые есть в последнем релизе Svace 3.3.2 но были пропущены в Svacer<br />
* Исправлено вылетание в Login Screen при удалении нотификации из панели нотификаций<br />
* Исправлено появление белого экрана при клике на детектор, информация о котором отсутствует<br />
* Ряд различных небольших исправлений в UI<br />
* Промежуточное хранилище будет очищаться по умолчанию при использовании команды import<br />
<br />
=== Release 6-0-0 === <br />
30.11.2022<br />
<br />
* Добавлено копирование комментариев при копировании разметки<br />
* Комментарии добавлены к отчету в формате csv<br />
* Добавлена возможность вводить пароль с клавиатуры для консольных команд<br />
* Добавлена возможность импортировать разметку из объекта сборки (из ранее загруженных данных)<br />
* Добавлена возможность импортировать разметку сразу после загрузки на сервер (опция для команды svacer upload)<br />
* Добавлена возможность загружать исходный код не из папки .svace-dir<br />
* Добавлена возможность бэкапа и восстановление объектного хранилища в сервер PostgresSQL<br />
* Добавлена возможность создания отчета по проекту в формате PDF через интерфейс командной строки и посредством REST API<br />
* Добавлена возможность подавления предупреждений через inline комментарии в коде<br />
* Добавлена возможность подавления предупреждений по идентификатору предупреждения через command line и REST API<br />
* Добавлена возможность ассоциировать организацию с пользователем и реестр организаций<br />
* Добавлена фильтрация списка комментариев по пользователю в правой панели веб-интерфейса<br />
* Добавлен поиск пользователей по его атрибутам в панели управления пользователями<br />
* Добавлена возможность заполнения данных профиля LDAP пользователя данными, полученными от LDAP сервера<br />
* Добавлена возможность прикреплять файлы к снимкам при импорте результатов (данные файлы составляют часть экспортируемых данных при экспорте снимков)<br />
* Добавлена возможность ассоциировать пользовательские атрибуты типа "строка" или массив строк со снимком при импорте данных (данные атрибуты составляют часть экспортируемых данных при экспорте снимков)<br />
* Добавлены command line операции по получению прикрепленных файлов и пользовательских атрибутов со снимков<br />
* Добавлена возможность группового добавления комментариев<br />
* Добавлена возможность указания сетевого интерфейса для работы WEB и GRPC серверов<br />
* Добавлен вывод краткой статистики по загруженному снимку при команде upload. Поддерживается текстовой и JSON форматы вывода<br />
* Существенно расширены возможности по интеграции Visual Studio Code с сервером Svacer<br />
* Добавлен флаг --git в команду import. При наличии такого флага, ищется ближайший git репозиторий содержащий .svace-dir и при наличии такого - используется путь к гит репозиторию для замены путей на префикс .build.<br />
* Portable PostgreSQL больше не входит в поставку. Вместо него поставляется docker-compose.yml файл для запуска PostgreSQL в докер-контейнере<br />
* Добавлено больше данных и информации об ошибках в вывод команды svacer import<br />
* Изменение Public API: добавлена точка входа /api/public/login<br />
* Операции по импорту и экспорту снимков доступны теперь обычным пользователям (не администраторам) при использовании command line интерфейса<br />
* Операция по экспорту снимков доступна обычному пользователю из веб-интерфейса (импорт все еще требует роль администратора для веб-интерфейса)<br />
* Операции по экспорту снимков переведены на асинхронный режим. Нотификация о готовности будет показана пользователю и доступна в панели нотификаций<br />
* Обновлено описание детекторов в соответствии с релизом Svace 3.3.2<br />
* Исправлена ошибка обработки корневых сертификатов при подключении к LDAP серверу по протоколу ldaps<br />
* Исправлено ошибочное создание дубликатов локальных учетных записей LDAP пользователей (case sensitive login)<br />
* Различные исправления в пользовательском интерфейсе с целью оптимизации производительности<br />
* Добавлены пропущенные проверки ролей при работе с веб-интерфейсом<br />
* Svacer больше не создает временные файлы в директории с исполняемым файлом<br />
* Устаранены задержки при удалении веток и проектов</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3271Help:CLI/cleanup2025-11-10T08:50:15Z<p>Gribunin: small cleanup changes</p>
<hr />
<div>= Автоматическое удаление снимков =<br />
<br />
== Обзор ==<br />
<br />
Удаление происходит по-умолчанию раз в 24 часа (время можно задать при запуске сервера опцией <code>--snapshots-cleanup-period</code>, либо в конфигурационном файле, либо переменной окружения <code>SVACER_CLEANUP_SNAPSHOTS_PERIOD</code>, но не меньше 15 минут). Первое удаление всех подходящих снимков будет через указанное время после запуска сервера.<br />
<br />
Применять может только пользователь с доступом '''ServerOperations'''.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление самых старых по времени создания подходящих снимков и заносится отметка в таблицу удаленных снимков и в системный журнал. После этого происходит удаление пустых веток и проектов в соответствии с правилами удаления. Также информация о удалении через cleanup вносится в системный журнал.<br />
<br />
== Добавление нового правила удаления ==<br />
<br />
svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --keep-time <nowiki><time></nowiki> --min-snapshots <min> --type <type><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех проектов)<br />
* <code>--branch</code> — ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--keep-time</code> — время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней).<br />
* <code>--min-snapshots</code> — количество снимков, которое необходимо оставлять в ветке, подходящей под паттерн project + branch. По умолчанию 0<br />
* <code>--cleanup-type</code> — тип очистки. Возможные значения - project, branch, snapshot (по умолчанию snapshot). При указании snapshot будут очищаться снимки в соответствии с паттерном проект+ветка+снимок и проверяться <code>keep-time</code> и <code>min-snapshots</code>. При указании branch будут удаляться пустые ветки в соответствии с паттерном project + branch. При указании project Будут удаляться пустые проекты (у которых нет веток) в соответствии с паттерном project. При указании branch или project невозможно указать <code>keep-time</code> и <code>min-snapshots</code>, эти флаги не учитываются.<br />
<br />
=== Шаблоны и паттерны ===<br />
<br />
Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:<br />
<br />
'''1. Имя или ID:'''<br />
--project "MyProject"<br />
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта<br />
<br />
'''2. <code>*</code> (любое количество любых символов):'''<br />
--project "Dev*" # DevProject, Development<br />
--branch "*test*" # test, my-test, testing<br />
--snapshot "nightly-*"<br />
<br />
'''3. Регулярные выражения (с префиксом <code>re:</code>):'''<br />
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5<br />
--branch "re:^feature/[0-9]+$" # feature/123<br />
<br />
== Добавление запрета на удаление ==<br />
<br />
svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --min-snapshots <min><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех проектов)<br />
<br />
* <code>--branch</code> — ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.<br />
<br />
== Удаление правила ==<br />
<br />
svacer server cleanup delete --user <user> --password <password> --id <config id><br />
<br />
Где:<br />
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)<br />
<br />
== Вывести таблицу ==<br />
<br />
svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json><br />
<br />
Где:<br />
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков<br />
<br />
* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат<br />
== Запуск очистки вручную ==<br />
<br />
svacer server cleanup run --user <user> --password <password><br />
<br />
Запускает процесс очистки немедленно (вне расписания).<br />
<br />
== Примеры ==<br />
<br />
=== Добавление нового правила ===<br />
<br />
'''Удаление по времени'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --keep-time "240h"<br />
<br />
Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".<br />
<br />
'''Ограничение количества'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 20<br />
<br />
В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.<br />
<br />
'''Очистка пустых веток'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "master" --cleanup-type branch<br />
<br />
В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*"<br />
<br />
Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются правилами cleanup'''.<br />
<br />
=== Вывод таблицы правил ===<br />
<br />
svacer server cleanup list --user admin --password admin --type rule<br />
[[File:Cleanup rules.png|none|thumb|955x955px]]<br />
<br />
=== Вывод таблицы запретов ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule<br />
[[File:Cleanup exclude rule table.png|center|thumb|1009x1009px]]<br />
<br />
=== Вывод в JSON формате ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule --format json<br />
<br />
Вывод:<br />
<br />
[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]<br />
<br />
=== Удаление правила ===<br />
<br />
svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416<br />
<br />
=== Использование regex ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --keep-time 168h<br />
<br />
Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code><br>Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code><br />
<br />
=== Regex синтаксис ===<br />
<br />
{| class="wikitable"<br />
! Паттерн !! Описание !! Пример<br />
|-<br />
| <code>^</code> || Начало строки || <code>^test</code><br />
|-<br />
| <code>[^x]</code> || Отрицание символов || <code>^[^m].*$</code><br />
|-<br />
| <code>$</code> || Конец строки || <code>test$</code><br />
|-<br />
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c<br />
|-<br />
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123<br />
|-<br />
| <code>.+</code> || Один или более || <code>test.+</code> → test-1<br />
|-<br />
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9<br />
|-<br />
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc<br />
|-<br />
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC<br />
|-<br />
| <code>(a&#124;b)</code> || "a" или "b" || <code>(test&#124;prod)</code><br />
|-<br />
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code><br />
|}<br />
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.<br />
<br />
Для правил отрицания конкретного элемента возможно использовать сложные правила, например:<br />
<br />
<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code><br />
<br />
Данное правило выбирает все ветки, кроме <code>main</code>.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Svacer&diff=3225Svacer2025-11-05T09:51:00Z<p>Gribunin: указано svace ver. checkers для Релизов</p>
<hr />
<div>Svacer — сервер для хранения и обработки результатов статического анализа. Поддерживает импорт результатов анализа из [https://svace.ispras.ru Svace] напрямую и из прочих анализаторов через формат [[Help:Sarif|SARIF]].<br />
<br />
=== Документация ===<br />
Version 11.x.x<br />
# [[Help:Introduction|Введение]]<br />
# [[Help:Installation|Установка и обновление]]<br />
# [[Help:Import from Svace|Импорт из Svace]]<br />
# [[Help:Backup|Резервное копирование]]<br />
# [[Help:UI manual|Использование веб-интерфейса]]<br />
# [[Help:Public API|Public REST API]]<br />
# [[Help:CLI|CLI]]<br />
# [[LDAP configuration|LDAP]]<br />
# [[OIDC|OpenID Connect]]<br />
# [[Help:Sarif|SARIF]]<br />
# [[Help:Statistics|Статистика]]<br />
# [[Help:Match|Механизмы сопоставления предупреждений и переноса разметки]]<br />
# [[Help:XSvacer|XSvacer — расширение функциональности Svacer]]<br />
# [[Help:Utils|Дополнительные утилиты]]<br />
# [[Metrics|Prometheus-метрики]]<br />
# [[Pipelines|Примеры пайплайнов]]<br />
# [[Notifications|Уведомления]]<br />
<br />
=== Релизы ===<br />
Также доступны в виде docker-образа на [https://hub.docker.com/r/ispras/svacer docker hub] и как пакеты в [[Help:Installation#Установка и запуск из deb/rpm пакета|репозиториях]]<br />
<br />
{| class="wikitable"<br />
! version !! distrib !! linux bin !! windows bin !! deb/rpm !! doc<br />
!svace ver. checkers<br />
|-<br />
| 11.2.0<br />
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-linux.tar.gz svacer-11-2-0-linux.tar.gz]<br />[https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11-2-0-windows.zip svacer-11-2-0-windows.zip]<br />
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer svacer]<br />[https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server svacer-server]<br />
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer.exe svacer.exe]<br />[https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-server.exe svacer-server.exe]<br />
| [https://svacer.ispras.ru/releases/svacer-11-2-0/svacer_11.2-0_amd64.deb svacer_11.2-0_amd64.deb]<br />[https://svacer.ispras.ru/releases/svacer-11-2-0/svacer-11.2-0.x86_64.rpm svacer-11.2-0.x86_64.rpm]<br />
| [[Changelog#Release 11-2-0|Changelog]]<br />[[Help:Installation#Обновление|Upgrade notes]]<br />[[Svacer#Документация|Documentation 11.x.x]]<br />
|4.0.250415<br />
|-<br />
| 11.1.0<br />
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-linux.tar.gz svacer-11-1-0-linux.tar.gz]<br />[https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11-1-0-windows.zip svacer-11-1-0-windows.zip]<br />
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer svacer]<br />[https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server svacer-server]<br />
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer.exe svacer.exe]<br />[https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-server.exe svacer-server.exe]<br />
| [https://svacer.ispras.ru/releases/svacer-11-1-0/svacer_11.1-0_amd64.deb svacer_11.1-0_amd64.deb]<br />[https://svacer.ispras.ru/releases/svacer-11-1-0/svacer-11.1-0.x86_64.rpm svacer-11.1-0.x86_64.rpm]<br />
| [[Changelog#Release 11-1-0|Changelog]]<br />[[Help:Installation#Обновление|Upgrade notes]]<br />[[Svacer#Документация|Documentation 11.x.x]]<br />
|4.0.250415<br />
|-<br />
| 11.0.0<br />
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-linux.tar.gz svacer-11-0-0-linux.tar.gz]<br />[https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11-0-0-windows.zip svacer-11-0-0-windows.zip]<br />
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer svacer]<br />[https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server svacer-server]<br />
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer.exe svacer.exe]<br />[https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-server.exe svacer-server.exe]<br />
| [https://svacer.ispras.ru/releases/svacer-11-0-0/svacer_11.0-0_amd64.deb svacer_11.0-0_amd64.deb]<br />[https://svacer.ispras.ru/releases/svacer-11-0-0/svacer-11.0-0.x86_64.rpm svacer-11.0-0.x86_64.rpm]<br />
| [[Changelog#Release 11-0-0|Changelog]]<br />[[Release notes 11-0-0|Release notes]]<br />[[Help:Installation#Обновление|Upgrade notes]]<br />[[Svacer#Документация|Documentation 11.x.x]]<br />
|4.0.250415<br />
|-<br />
| 10.0.1<br />
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-linux.tar.gz svacer-10-0-1-linux.tar.gz]<br />[https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10-0-1-windows.zip svacer-10-0-1-windows.zip]<br />
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer svacer]<br />[https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server svacer-server]<br />
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer.exe svacer.exe]<br />[https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-server.exe svacer-server.exe]<br />
| [https://svacer.ispras.ru/releases/svacer-10-0-1/svacer_10.0-1_amd64.deb svacer_10.0-1_amd64.deb]<br />[https://svacer.ispras.ru/releases/svacer-10-0-1/svacer-10.0-1.x86_64.rpm svacer-10.0-1.x86_64.rpm]<br />
| [[Changelog#Release 10-0-1|Changelog]]<br />[[Help:Installation#Обновление|Upgrade notes]]<br />[[Documentation 10.x.x]]<br />
|4.0.241102<br />
|-<br />
| 10.0.0<br />
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-linux.tar.gz svacer-10-0-0-linux.tar.gz]<br />[https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10-0-0-windows.zip svacer-10-0-0-windows.zip]<br />
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer svacer]<br />[https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server svacer-server]<br />
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer.exe svacer.exe]<br />[https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-server.exe svacer-server.exe]<br />
| [https://svacer.ispras.ru/releases/svacer-10-0-0/svacer_10.0-0_amd64.deb svacer_10.0-0_amd64.deb]<br />[https://svacer.ispras.ru/releases/svacer-10-0-0/svacer-10.0-0.x86_64.rpm svacer-10.0-0.x86_64.rpm]<br />
| [[Changelog#Release 10-0-0|Changelog]]<br />[[Release notes 10-0-0|Release notes]]<br />[[Help:Installation#Обновление|Upgrade notes]]<br />[[Documentation 10.x.x]]<br />
|4.0.241102<br />
|-<br />
| 9.0.2<br />
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9-0-2.zip svacer-9-0-2.zip]<br />
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer svacer]<br />[https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server svacer-server]<br />
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer.exe svacer.exe]<br />[https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-server.exe svacer-server.exe]<br />
| [https://svacer.ispras.ru/releases/svacer-9-0-2/svacer_9.0-2_amd64.deb svacer_9.0-2_amd64.deb]<br />[https://svacer.ispras.ru/releases/svacer-9-0-2/svacer-9.0-2.x86_64.rpm svacer-9.0-2.x86_64.rpm]<br />
| [[Changelog#Release 9-0-2|Changelog]]<br />[[Help:Installation#9-0-0|Upgrade notes]]<br />[[Documentation 9.x.x]]<br />
|3.4.240312<br />
|-<br />
| 9.0.1<br />
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9-0-1.zip svacer-9-0-1.zip]<br />
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer svacer]<br />[https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server svacer-server]<br />
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer.exe svacer.exe]<br />[https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-server.exe svacer-server.exe]<br />
| [https://svacer.ispras.ru/releases/svacer-9-0-1/svacer_9.0-1_amd64.deb svacer_9.0-1_amd64.deb]<br />[https://svacer.ispras.ru/releases/svacer-9-0-1/svacer-9.0-1.x86_64.rpm svacer-9.0-1.x86_64.rpm]<br />
| [[Changelog#Release 9-0-1|Changelog]]<br />[[Help:Installation#9-0-0|Upgrade notes]]<br />[[Documentation 9.x.x]]<br />
|3.4.240312<br />
|-<br />
| 9.0.0<br />
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9-0-0.zip svacer-9-0-0.zip]<br />
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer svacer]<br />[https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server svacer-server]<br />
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer.exe svacer.exe]<br />[https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-server.exe svacer-server.exe]<br />
| [https://svacer.ispras.ru/releases/svacer-9-0-0/svacer_9.0-0_amd64.deb svacer_9.0-0_amd64.deb]<br />[https://svacer.ispras.ru/releases/svacer-9-0-0/svacer-9.0-0.x86_64.rpm svacer-9.0-0.x86_64.rpm]<br />
| [[Changelog#Release 9-0-0|Changelog]]<br />[[Release notes 9-0-0|Release notes]]<br />[[Help:Installation#9-0-0|Upgrade notes]]<br />[[Documentation 9.x.x]]<br />
|3.4.240312<br />
|-<br />
| 8.0.1 <br />
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8-0-1.zip svacer-8-0-1.zip]<br />
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer svacer]<br />
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer.exe svacer.exe]<br />
| [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer_8.0-1_amd64.deb svacer_8.0-1_amd64.deb]<br /> [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0-1.x86_64.rpm svacer-8.0-1.x86_64.rpm]<br /> [https://svacer.ispras.ru/releases/svacer-8-0-1/svacer-8.0.1.msi svacer-8.0.1.msi]<br />
| [[Changelog#Release 8-0-1|Changelog]]<br />[[Documentation 8.x.x]]<br />
|3.4.0<br />
|-<br />
| 8.0.0 <br />
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8-0-0.zip svacer-8-0-0.zip]<br />
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer svacer]<br />
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer.exe svacer.exe]<br />
| [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer_8.0-0_amd64.deb svacer_8.0-0_amd64.deb]<br /> [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0-0.x86_64.rpm svacer-8.0-0.x86_64.rpm]<br /> [https://svacer.ispras.ru/releases/svacer-8-0-0/svacer-8.0.0.msi svacer-8.0.0.msi]<br />
| [[Changelog#Release 8-0-0|Changelog]]<br />[[Release notes 8-0-0|Release notes]]<br />[[Documentation 8.x.x]]<br />
|3.4.0<br />
|}<br />
<br />
[https://svacer.ispras.ru/releases Предыдущие релизы] | [https://nextcloud.ispras.ru/index.php/s/x4r4cMJAMr5RZtd?path=%2F Еще более старые релизы]<br />
<br />
=== FAQ ===<br />
* [https://gitlab.ispras.ru/svace/svace-support/-/wikis/home Документация на статический анализатор Svace]<br />
* [[Help:Introduction#Системные требования|Системные требования]]<br />
* [[Примеры использования хуков#Создание кейсов в системах отслеживания ошибок|Создание из Svacer кейсов в Gitlab, Jira, Redmine]]<br />
* Public REST API <br />
:* [[Help:Public API#Примеры использования public REST API|Примеры использования]]<br />
:* [https://gitlab.ispras.ru/svacer-public Репозитории с примерами на Python и Go] <br />
:* [https://svacer-demo.ispras.ru/api/public/swagger/ Спецификация OpenAPI]<br />
* [https://t.me/+6pvgZ0oveNVhOTc6 Группа технической поддержки в Telegram]<br />
<br />
=== Демо ===<br />
https://svacer-demo.ispras.ru<br />
<br />
* admin / admin — логин / пароль администратора<br />
* user / user — логин / пароль пользователя<br />
<br />
https://svacer-ai-demo.ispras.ru/ — [[Help:XSvacer:AIAssistant|ИИ-ассистент]]<br />
* admin / admin</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Release_notes_12-0-0&diff=3164Release notes 12-0-02025-10-28T13:15:46Z<p>Gribunin: /* Автоочистка снимков/веток/проектов */ добавил опции cleanup-type и убрал Max-snapshots</p>
<hr />
<div>== Разметка маркеров с помощью AI ==<br />
Добавлена возможность разметки маркеров с помощью ассистента AI, который на основании модели, обученной на множестве размеченных данных, предсказывает статус разметки маркера False Positive или Confirmed. <br />
<br />
Если пользователь применяет предсказанный статус маркера, то к маркеру автоматически добавляется комментарий с информацией о дате разметки, используемой модели AI и уровне доверия, также маркеру добавляется метка '''AI'''.<br />
<br />
{{Note|type=info|text=''Прогнозируемый ассистентом AI статус разметки маркера носит рекомендательный характер. Окончательное решение о применении предсказанного моделью статуса остается за пользователем.''}}<br />
<br />
Форма разметки с помощью AI открывается включением параметра '''Режим разметки с помощью AI''' на стандартных формах разметки маркера или групповой разметки маркера.<br />
<br />
Если текущий статус разметки маркера совпадает со статусом, предсказанным моделью AI, то такой маркер повторно разметить с помощью AI нельзя.<br />
<br />
[[File:Review marker-1.png|thumb|none|x250px|Форма разметки одного маркера]]<br />
<br />
[[File:Review marker-2.png|thumb|none|x250px|Форма групповой разметки маркеров]]<br />
<br />
== Изменения в пользовательских фильтрах ==<br />
В пользовательских фильтрах реализованы дополнительные возможности фильтрации маркеров:<br />
<br />
1. Атрибут «'''Период последнего изменения'''» для фильтрации маркеров по дате (периоду) актуальной разметки.<br />
<br />
2. Поле ввода шаблона расширенного фильтра для фильтрации маркеров по сложным предикатам, таким как:<br />
<br />
* поля маркера, его трассы, разметки и комментариев;<br />
* информацию из контекста (имя проекта, ветки, снимка и т. п.);<br />
* атрибуты снимка (включая пользовательские атрибуты, заданные при импорте);<br />
* статусы разметки;<br />
* текст и атрибуты комментариев.<br />
<br />
Описание, как составить выражение для расширенного фильтра, можно получить, кликнув на [[File:icon_question_mark2.png|x25px]].<br />
[[File:Custom filter v12.png|thumb|none|x450px]]<br />
<br />
== Изменения в разделе '''Поиск''' ==<br />
В разделе '''Поиск''' выполнены следующие доработки:<br />
<br />
1. Реализована возможность просмотра информации о маркере непосредственно в разделе '''Поиск'''.<br />
[[File:Search-1.png|thumb|none|upright=4]]<br />
<br />
2. Поиск маркеров по полям расширен дополнительными атрибутами:<br />
<br />
* Инвариант маркера;<br />
* ID маркера.<br />
<br />
[[File:Search-2.png|thumb|none|upright=4]]<br />
<br />
== Изменения на вкладке с исходным кодом файла ==<br />
1. Панель функций перенесена на верх вкладки с файлом исходного кода.<br />
<br />
2. Реализована возможность добавления файла в фильтр по файлам, а также исключения файла из фильтра, если он был добавлен ранее.<br />
[[File:Cove view.png|thumb|none|upright=4.5]]<br />
<br />
== Сравнение маркеров при их сопоставлении ==<br />
В процессе сопоставления маркеров реализована возможность сравнения маркеров. Это помогает определить причину, почему при импорте снимка маркеры не сопоставились автоматически.<br />
[[File:Match markers-1.png|thumb|none|upright=3.5]]<br />
<br />
Форма сравнения маркеров открывается в отдельном диалоговом окне.<br />
[[File:Match markers-2.png|thumb|none|upright=3.5]]<br />
<br />
== Просмотр JSON маркера ==<br />
В дополнение к команде копирования JSON маркера добавлена команда просмотра JSON маркера в таблице маркеров и правой панели.<br />
[[File:JSON-1.png|thumb|none|upright=3.5]]<br />
<br />
Просмотр JSON осуществляется в отдельном диалоговом окне.<br />
[[File:JSON-2.png|thumb|none|upright=3.5]]<br />
<br />
== Изменения в разделе '''Проекты''' ==<br />
1. Фокусировка на ветке master при создании нового проекта.<br />
<br />
2. В действия над снимком в списке снимков добавлена команда экспорта кода с разметкой. Все команды экспорта снимка вынесены в отдельное меню.<br />
[[File:Project 1.png|thumb|none|upright=4]]<br />
<br />
== Редактирование маркеров при импорте ==<br />
<br />
При импорте .svace-dir, SARIF или snap-файла добавлена возможность (опция) задать правила трансформации, пропуска и дедупликации маркеров. Правила задаются в JSON-формате. <br />
<br />
При импорте в CLI данная опция называется edit-markers и позволяет указать путь к JSON-файлу с правилами. Подробнее здесь: [[Edit markers (command line)]]. <br />
<br />
В пользовательском интерфейсе при импорте .svace-dir или SARIF возможно задать данную опцию и в ней указать путь к JSON-файлу в архиве .svace-dir или SARIF. А при импорте snap-файла возможно как подгрузить JSON-файл, так и ввести выражение в формате JSON в поле ввода. <br />
<br />
[[File:Edit markers svace-dir.png|thumb|none|upright=3|Форма импорта .svace-dir]]<br />
[[File:Edit_markers_sarif.png|thumb|none|upright=3|Форма импорта SARIF]]<br />
[[File:Edit markers snap.png|thumb|none|upright=3|Форма импорта snap-файла]]<br />
<br />
== Добавлена форма управления асинхронными задачами ==<br />
В разделе '''Настройки > Асинхронные задачи''', где доступен просмотр и управление (отмена и откат) следующими асинхронными операциями:<br />
<br />
* Экспорт snap-файлов;<br />
* Экспорт SARIF;<br />
* Копирование снимков.<br />
<br />
Пользователь с серверным доступом '''Администрирование сервера''' может просматривать и управлять запущенными или выполненными асинхронными задачами всех пользователей. Пользователю без данного доступа доступно управление только своими асинхронными задачами.<br />
<br />
[[File:Async tasks.png|thumb|none|upright=4|Форма Асинхронные задачи]]<br />
<br />
В следующем релизе планируем интегрировать в данный раздел оставшиеся асинхронные операции, которые запускаются пользователями, а именно:<br />
<br />
* Импорт snapshot;<br />
* Импорт svace-dir;<br />
* Импорт SARIF;<br />
* Копирование проекта;<br />
* Копирование ветки.<br />
<br />
== Изменения в разделе '''Информация о сервере''' ==<br />
В разделе '''Настройки > Информация о сервере''', который доступен пользователям с серверным доступом '''Администрирование сервера''', представление информации разделено на три вкладки:<br />
<br />
* Параметры;<br />
* Системный лог;<br />
* Системный журнал.<br />
<br />
Т. к. системный лог может иметь большой размер, то вывод информации на форме ограничен последними 1Мб (значение регулируется переменной окружения SVACER_TAIL_LOG_SIZE). Скачивание лога позволяет выгрузить файл полностью.<br />
<br />
[[File:Server info-1.png|thumb|none|upright=4|Информация о сервере — вкладка Параметры]]<br />
[[File:Server info-2.png|thumb|none|upright=4|Информация о сервере — вкладка Системный лог]]<br />
[[File:Server info-3.png|thumb|none|upright=4|Информация о сервере — вкладка Системный журнал]]<br />
<br />
== Лицензирование Svacer ==<br />
Реализован механизм лицензирования. Просмотр и применение лицензии доступно в CLI, а также в UI, где добавлен раздел Лицензия. Просмотр лицензии доступен всем пользователям, а активация лицензии — пользователям с серверным доступом «Администрирование сервера».<br />
<br />
[[File:Licence.png|thumb|none|upright=3.5]]<br />
<br />
{{Note|type=info|text=''Функциональность добавлена для возможности будущего развития продукта. В дистрибутив Svacer v.12 лицензия встроена и не вносит никаких ограничений. Срок действия встроенной лицензии — до 31.12.2027.''}}<br />
<br />
== Парольная политика ==<br />
Реализована возможность задать парольную политику в конфигурационном файле:<br />
<br />
1. Механизм установки минимальной сложности паролей.<br />
<br />
Пример задания конфигурационных настроек:<br />
auth:<br />
svacer:<br />
password:<br />
min_length: 10<br />
complexity:<br />
- "[a-z]"<br />
- "[A-Z]"<br />
- "[0-9]"<br />
- "[!#]"<br />
<br />
В поле min_length — минимальная длина пароля. В поле complexity список регулярных выражений, задающих группу требуемых символов. В примере требуется наличие строчных, заглавных букв, цифр и спецсимволов <code>!#</code>.<br />
<br />
2. Механизм блокировки учетной записи пользователя при нескольких неудачных попытках авторизации.<br />
<br />
Пример задания конфигурационных настроек:<br />
<br />
security:<br />
login:<br />
max_attempts: 5<br />
lock_time: 2m<br />
<br />
Т. е. учетная запись будет блокироваться на 2 минуты при 5 неудачных попытках авторизации.<br />
<br />
Также реализована команда CLI для разблокировки учетной записи пользователя:<br />
svacer user-proiver unlock -login chernykov_sv<br />
<br />
== Открытие вкладки LDAP по умолчанию ==<br />
Добавлен параметр конфигурации default. Если он true, то на странице авторизации в пользовательском интерфейсе по умолчанию будет открываться вкладка Svacer, если false — то при наличии сконфигурированного LDAP по умолчанию будет открываться вкладка LDAP, иначе флаг default игнорируется.<br />
<br />
Пример задания конфигурационных настроек:<br />
auth:<br />
svacer:<br />
enabled: true<br />
default: false<br />
<br />
== Автоочистка снимков/веток/проектов ==<br />
Расширены опции команды cleanup, вызываемой в CLI:<br />
<br />
* cleanup-type — удалять пустые ветки и проекты;<br />
* min-snapshots — нижняя граница по количеству снимков в ветке.<br />
<br />
Подробное описание функции и ее опций: [[Help:CLI/cleanup]].<br />
<br />
== Веб-хуки для нотификаций ==<br />
Реализован механизм веб-хуков для отправки нотификаций по API во внешние системы. Механизм настраивается в конфигурационном файле в секции webhook.<br />
<br />
Реализована отправка нотификаций по следующим событиям:<br />
<br />
* разметка маркера / групповая разметка маркеров;<br />
* добавление / обновление комментария маркера;<br />
* добавление / копирование / изменение / удаление контейнеров (группа / проект / ветка);<br />
* импорт / копирование / удаление / изменение снимков;<br />
* копирование разметки.<br />
<br />
Пример задания конфигурационных настроек:<br />
<br />
webhook:<br />
enabled: true<br />
journalLength: 86400<br />
targets:<br />
- url: "<nowiki>https://swarm-mgr.home:8080/webhook</nowiki>"<br />
workersCount: 1<br />
enabled: true <br />
filter: "Type == 1 and Payload.Status != 'Undecided'"<br />
caCerts: ""<br />
retryCount: 1<br />
timeout: 500<br />
<br />
Управление механизмом осуществляется в CLI с помощью команд:<br />
<br />
* просмотра записей журнала отправки событий:<br />
<br />
svacer server webhook journal<br />
<br />
* просмотр статистики по работе службы:<br />
<br />
svacer server webhook stat</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3163Help:CLI/cleanup2025-10-28T13:13:43Z<p>Gribunin: cleanup-type add</p>
<hr />
<div>= Автоматическое удаление снимков =<br />
<br />
== Обзор ==<br />
<br />
Удаление происходит раз в 24 часа (данное время можно задать при запуске сервера опцией <code>--snapshots-cleanup-period</code>, либо в конфигурационном файле, либо переменной окружения <code>SVACER_CLEANUP_SNAPSHOTS_PERIOD</code>), первое удаление всех подходящих снимков будет через указанное время после запуска сервера.<br />
<br />
Применять может только пользователь с доступом '''ServerOperations'''.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление самых старых по времени создания подходящих снимков и заносится отметка в таблицу удаленных снимков и в системный журнал. После этого происходит удаление пустых веток и проектов в соответствии с правилами удаления. Также информация о удалении через cleanup вносится в системный журнал.<br />
<br />
== Добавление нового правила удаления ==<br />
<br />
svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --keep-time <nowiki><time></nowiki> --max-snapshots <max> --type <type><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех проектов)<br />
* <code>--branch</code> — ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--keep-time</code> — время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней). '''Игнорируется, если <code>--max-snapshots > 0</code>'''<br />
* <code>--min-snapshots</code> — количество снимков, которое необходимо оставлять в ветке, подходящей под паттерн project + branch. По умолчанию 0<br />
* <code>--cleanup-type</code> — тип очистки. Возможные значения - project, branch, snapshot (по умолчанию snapshot). При указании snapshot будут очищаться снимки в соответствии с паттерном проект+ветка+снимок и проверяться <code>keep-time</code> и <code>min-snapshots</code>. При указании branch будут удаляться пустые ветки в соответствии с паттерном project + branch. При указании project Будут удаляться пустые проекты (у которых нет веток) в соответствии с паттерном project. При указании branch или project невозможно указать <code>keep-time</code> и <code>min-snapshots</code>, эти флаги не учитываются.<br />
<br />
=== Шаблоны и паттерны ===<br />
<br />
Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:<br />
<br />
'''1. Имя или ID:'''<br />
--project "MyProject"<br />
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта<br />
<br />
'''2. <code>*</code> (любое количество любых символов):'''<br />
--project "Dev*" # DevProject, Development<br />
--branch "*test*" # test, my-test, testing<br />
--snapshot "nightly-*"<br />
<br />
'''3. Регулярные выражения (с префиксом <code>re:</code>):'''<br />
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5<br />
--branch "re:^feature/[0-9]+$" # feature/123<br />
<br />
== Добавление запрета на удаление ==<br />
<br />
svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --min-snapshots <min><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех проектов)<br />
<br />
* <code>--branch</code> — ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.<br />
<br />
== Удаление правила ==<br />
<br />
svacer server cleanup delete --user <user> --password <password> --id <config id><br />
<br />
Где:<br />
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)<br />
<br />
== Вывести таблицу ==<br />
<br />
svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json><br />
<br />
Где:<br />
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков<br />
<br />
* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат<br />
== Запуск очистки вручную ==<br />
<br />
svacer server cleanup run --user <user> --password <password><br />
<br />
Запускает процесс очистки немедленно (вне расписания).<br />
<br />
== Примеры ==<br />
<br />
=== Добавление нового правила ===<br />
<br />
'''Удаление по времени'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --keep-time "240h"<br />
<br />
Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".<br />
<br />
'''Ограничение количества'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 20<br />
<br />
В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.<br />
<br />
'''Очистка пустых веток'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "master" --cleanup-type branch<br />
<br />
В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*"<br />
<br />
Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются правилами cleanup'''.<br />
<br />
=== Вывод таблицы правил ===<br />
<br />
svacer server cleanup list --user admin --password admin --type rule<br />
[[File:Cleanup rules.png|none|thumb|955x955px]]<br />
<br />
=== Вывод таблицы запретов ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule<br />
[[File:Cleanup exclude rule table.png|center|thumb|1009x1009px]]<br />
<br />
=== Вывод в JSON формате ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule --format json<br />
<br />
Вывод:<br />
<br />
[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]<br />
<br />
=== Удаление правила ===<br />
<br />
svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416<br />
<br />
=== Использование regex ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --keep-time 168h<br />
<br />
Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code><br>Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code><br />
<br />
=== Regex синтаксис ===<br />
<br />
{| class="wikitable"<br />
! Паттерн !! Описание !! Пример<br />
|-<br />
| <code>^</code> || Начало строки || <code>^test</code><br />
|-<br />
| <code>[^x]</code> || Отрицание символов || <code>^[^m].*$</code><br />
|-<br />
| <code>$</code> || Конец строки || <code>test$</code><br />
|-<br />
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c<br />
|-<br />
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123<br />
|-<br />
| <code>.+</code> || Один или более || <code>test.+</code> → test-1<br />
|-<br />
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9<br />
|-<br />
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc<br />
|-<br />
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC<br />
|-<br />
| <code>(a&#124;b)</code> || "a" или "b" || <code>(test&#124;prod)</code><br />
|-<br />
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code><br />
|}<br />
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.<br />
<br />
Для правил отрицания конкретного элемента возможно использовать сложные правила, например:<br />
<br />
<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code><br />
<br />
Данное правило выбирает все ветки, кроме <code>main</code>.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Cleanup_rules.png&diff=3162File:Cleanup rules.png2025-10-28T13:12:10Z<p>Gribunin: </p>
<hr />
<div>cleanup rules</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Edit_markers_(command_line)&diff=3161Edit markers (command line)2025-10-27T11:40:36Z<p>Gribunin: more describe about edit-markers</p>
<hr />
<div>== Обзор ==<br />
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:<br />
<br />
* '''skip''' — пропуск (удаление) маркеров, соответствующих условию<br />
* '''change''' — изменение полей маркеров<br />
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяется трасса и остается только один (случайный) маркер с объединенной трассой, остальные маркеры удаляются.<br />
Все операции происходят на стороне клиента до загрузки данных на сервер. При импорте результатов Svace, а также sarif (без указания флага --upload) изменяется .svacer-dir. Директория .svace-dir остается неизменной. Снимок остается неизменным при импорте.<br />
<br />
== Использование ==<br />
<br />
=== Импорт результатов Svace ===<br />
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила редактирования к маркерам при импорте результатов анализа Svace.<br />
<br />
=== Импорт SARIF ===<br />
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при импорте SARIF-файлов.<br />
<br />
=== Импорт снимка с редактированием ===<br />
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила к снимку при импорте. Дополнительно можно сохранить отредактированный снимок:<br />
<br />
<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code><br />
<br />
== Формат файла правил ==<br />
Правила задаются в виде JSON-файла, содержащего массив объектов правил:<br />
[{<br />
"action": "тип_действия",<br />
"rules": "условие_или_список_полей",<br />
"change": { /* только для action: "change" */ }<br />
}]<br />
<br />
=== Типы действий ===<br />
<br />
==== skip — Пропуск маркеров ====<br />
Удаляет маркеры, соответствующие условию.<br />
{<br />
"action": "skip",<br />
"rules": "file == 'test.cpp' and line > 100"<br />
}<br />
<br />
==== change — Изменение маркеров ====<br />
Изменяет указанные поля маркеров.<br />
{<br />
<nowiki> </nowiki>"action": "change",<br />
<nowiki> </nowiki>"rules": "warnclass == 'UNREACHABLE_CODE'",<br />
<nowiki> </nowiki>"change": {<br />
<nowiki> </nowiki> "warnclass": "IGNORED",<br />
<nowiki> </nowiki> "msg": "Код помечен как недостижимый"<br />
<nowiki> </nowiki>}}<br />
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.<br />
<br />
==== deduplicate — Дедупликация ====<br />
Объединяет маркеры с одинаковыми значениями указанных полей.<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.<br />
<br />
== Доступные поля и операторы ==<br />
<br />
=== Поля маркеров ===<br />
В условиях можно использовать следующие поля:<br />
<br />
* <code>file</code> — путь к файлу (строка)<br />
* <code>line</code> — номер строки (число)<br />
* <code>function</code> — имя функции (строка)<br />
* <code>warnclass</code> — класс предупреждения (строка)<br />
* <code>lang</code> — язык программирования (строка)<br />
* <code>tool</code> — инструмент анализа (строка)<br />
* <code>mtid</code> — ID типа маркера (строка)<br />
* <code>msg</code> — сообщение маркера (строка)<br />
* <code>details</code> — детали маркера (строка)<br />
<br />
=== Операторы сравнения ===<br />
<br />
* <code>==</code>, <code>!=</code> — равно, не равно<br />
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел<br />
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы<br />
* <code>not</code>, <code>!</code> — логическое НЕ<br />
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)<br />
* <code>contains</code> — проверка вхождения подстроки<br />
<br />
=== Функции для работы со строками ===<br />
<br />
* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)<br />
* <code>hasPrefix(s, prefix)</code> — начинается с префикса<br />
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом<br />
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра<br />
* <code>lower(s)</code> — преобразование в нижний регистр<br />
* <code>upper(s)</code> — преобразование в верхний регистр<br />
* <code>trim(s)</code> — удаление пробелов в начале и конце строки<br />
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки<br />
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению<br />
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению<br />
<br />
== Примеры ==<br />
<br />
=== Пропуск тестовых файлов ===<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'test') or icontains(file, 'spec')"<br />
}<br />
]<br />
<br />
=== Изменение класса предупреждений ===<br />
[<br />
{<br />
"action": "change",<br />
"rules": "warnclass == 'UNREACHABLE_CODE' and icontains(file, 'generated')",<br />
"change": {<br />
"warnclass": "INFO",<br />
"msg": "Недостижимый код в сгенерированном файле"<br />
}<br />
}<br />
]<br />
<br />
=== Удаление дубликатов ===<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
]<br />
<br />
=== Комплексный пример ===<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "file == '.build/src/generated.c'"<br />
},<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,function"<br />
},<br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['DEBUG', 'TRACE', 'INFO'] and line > 1000",<br />
"change": {<br />
"warnclass": "LOW_PRIORITY",<br />
"msg": "Низкоприоритетное предупреждение в длинном файле"<br />
}<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "regex(file, \".*_test\\\\.(c|cpp)$\")"<br />
}<br />
]<br />
<br />
=== Изменение приоритета для определенных классов ===<br />
Понижаем приоритет информационных сообщений:<br />
[ <br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['UNREACHABLE_CODE.ENUM', 'UNREACHABLE_CODE.RET', 'UNUSED_VALUE.PARAM_ASSIGN']",<br />
"change": {<br />
"warnclass": "UNREACHABLE_CODE"<br />
}<br />
}<br />
]<br />
<br />
=== Обработка сгенерированных файлов ===<br />
Пропускаем все маркеры в сгенерированных файлах:<br />
<br />
[ <br />
{<br />
"action": "skip",<br />
"rules": "contains(file, 'generated') or contains(file, '.build') or hasPrefix(file, 'vendor/')"<br />
}<br />
]<br />
<br />
=== Дедупликация с последующей фильтрацией ===<br />
Сначала объединяем дубликаты, потом удаляем ненужные:<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass,function"<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"<br />
}<br />
]<br />
<br />
=== Работа с регулярными выражениями ===<br />
Фильтрация по сложным паттернам путей:<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "regex(file, \"^(tests?|spec|mock|stub)/.*$\") or nregex(file, \"^src/.*\\.(c|cpp|h|hpp)$\")"<br />
}<br />
]<br />
<br />
== Дополнительные опции ==<br />
<br />
=== Сохранение отредактированного снимка ===<br />
При импорте снимка можно сохранить результат применения правил:<br />
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...<br />
Обязательно должно быть расширение <code>.snap</code> для сохранения.<br />
<br />
== Важные замечания ==<br />
<br />
# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле<br />
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей<br />
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code><br />
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)<br />
# '''Поле line в change''' — должно быть строкой с неотрицательным числом<br />
# '''Поле warnclass в change''' — может принимать только русские, английский буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Edit_markers_(command_line)&diff=3160Edit markers (command line)2025-10-24T18:23:06Z<p>Gribunin: edit-markers remove upload and line change</p>
<hr />
<div>== Обзор ==<br />
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:<br />
<br />
* '''skip''' — пропуск (удаление) маркеров, соответствующих условию<br />
* '''change''' — изменение полей маркеров<br />
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяется трасса и остается только один (случайный) маркер с объединенной трассой, остальные маркеры удаляются.<br />
<br />
== Использование ==<br />
<br />
=== Импорт результатов Svace ===<br />
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила редактирования к маркерам при импорте результатов анализа Svace.<br />
<br />
=== Импорт SARIF ===<br />
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при импорте SARIF-файлов.<br />
<br />
=== Импорт снимка с редактированием ===<br />
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила к снимку при импорте. Дополнительно можно сохранить отредактированный снимок:<br />
<br />
<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code><br />
<br />
== Формат файла правил ==<br />
Правила задаются в виде JSON-файла, содержащего массив объектов правил:<br />
[{<br />
"action": "тип_действия",<br />
"rules": "условие_или_список_полей",<br />
"change": { /* только для action: "change" */ }<br />
}]<br />
<br />
=== Типы действий ===<br />
<br />
==== skip — Пропуск маркеров ====<br />
Удаляет маркеры, соответствующие условию.<br />
{<br />
"action": "skip",<br />
"rules": "file == 'test.cpp' and line > 100"<br />
}<br />
<br />
==== change — Изменение маркеров ====<br />
Изменяет указанные поля маркеров.<br />
{<br />
<nowiki> </nowiki>"action": "change",<br />
<nowiki> </nowiki>"rules": "warnclass == 'UNREACHABLE_CODE'",<br />
<nowiki> </nowiki>"change": {<br />
<nowiki> </nowiki> "warnclass": "IGNORED",<br />
<nowiki> </nowiki> "msg": "Код помечен как недостижимый"<br />
<nowiki> </nowiki>}}<br />
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.<br />
<br />
==== deduplicate — Дедупликация ====<br />
Объединяет маркеры с одинаковыми значениями указанных полей.<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.<br />
<br />
== Доступные поля и операторы ==<br />
<br />
=== Поля маркеров ===<br />
В условиях можно использовать следующие поля:<br />
<br />
* <code>file</code> — путь к файлу (строка)<br />
* <code>line</code> — номер строки (число)<br />
* <code>function</code> — имя функции (строка)<br />
* <code>warnclass</code> — класс предупреждения (строка)<br />
* <code>lang</code> — язык программирования (строка)<br />
* <code>tool</code> — инструмент анализа (строка)<br />
* <code>mtid</code> — ID типа маркера (строка)<br />
* <code>msg</code> — сообщение маркера (строка)<br />
* <code>details</code> — детали маркера (строка)<br />
<br />
=== Операторы сравнения ===<br />
<br />
* <code>==</code>, <code>!=</code> — равно, не равно<br />
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел<br />
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы<br />
* <code>not</code>, <code>!</code> — логическое НЕ<br />
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)<br />
* <code>contains</code> — проверка вхождения подстроки<br />
<br />
=== Функции для работы со строками ===<br />
<br />
* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)<br />
* <code>hasPrefix(s, prefix)</code> — начинается с префикса<br />
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом<br />
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра<br />
* <code>lower(s)</code> — преобразование в нижний регистр<br />
* <code>upper(s)</code> — преобразование в верхний регистр<br />
* <code>trim(s)</code> — удаление пробелов в начале и конце строки<br />
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки<br />
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению<br />
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению<br />
<br />
== Примеры ==<br />
<br />
=== Пропуск тестовых файлов ===<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'test') or icontains(file, 'spec')"<br />
}<br />
]<br />
<br />
=== Изменение класса предупреждений ===<br />
[<br />
{<br />
"action": "change",<br />
"rules": "warnclass == 'UNREACHABLE_CODE' and icontains(file, 'generated')",<br />
"change": {<br />
"warnclass": "INFO",<br />
"msg": "Недостижимый код в сгенерированном файле"<br />
}<br />
}<br />
]<br />
<br />
=== Удаление дубликатов ===<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
]<br />
<br />
=== Комплексный пример ===<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "file == '.build/src/generated.c'"<br />
},<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,function"<br />
},<br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['DEBUG', 'TRACE', 'INFO'] and line > 1000",<br />
"change": {<br />
"warnclass": "LOW_PRIORITY",<br />
"msg": "Низкоприоритетное предупреждение в длинном файле"<br />
}<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "regex(file, \".*_test\\\\.(c|cpp)$\")"<br />
}<br />
]<br />
<br />
=== Изменение приоритета для определенных классов ===<br />
Понижаем приоритет информационных сообщений:<br />
[ <br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['UNREACHABLE_CODE.ENUM', 'UNREACHABLE_CODE.RET', 'UNUSED_VALUE.PARAM_ASSIGN']",<br />
"change": {<br />
"warnclass": "UNREACHABLE_CODE"<br />
}<br />
}<br />
]<br />
<br />
=== Обработка сгенерированных файлов ===<br />
Пропускаем все маркеры в сгенерированных файлах:<br />
<br />
[ <br />
{<br />
"action": "skip",<br />
"rules": "contains(file, 'generated') or contains(file, '.build') or hasPrefix(file, 'vendor/')"<br />
}<br />
]<br />
<br />
=== Дедупликация с последующей фильтрацией ===<br />
Сначала объединяем дубликаты, потом удаляем ненужные:<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass,function"<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"<br />
}<br />
]<br />
<br />
=== Работа с регулярными выражениями ===<br />
Фильтрация по сложным паттернам путей:<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "regex(file, \"^(tests?|spec|mock|stub)/.*$\") or nregex(file, \"^src/.*\\.(c|cpp|h|hpp)$\")"<br />
}<br />
]<br />
<br />
== Дополнительные опции ==<br />
<br />
=== Сохранение отредактированного снимка ===<br />
При импорте снимка можно сохранить результат применения правил:<br />
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...<br />
Обязательно должно быть расширение <code>.snap</code> для сохранения.<br />
<br />
== Важные замечания ==<br />
<br />
# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле<br />
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей<br />
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code><br />
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)<br />
# '''Поле line в change''' — должно быть строкой с неотрицательным числом<br />
# '''Поле warnclass в change''' — может принимать только русские, английский буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3159Help:CLI/cleanup2025-10-24T18:14:30Z<p>Gribunin: cleanup remove max mode and change min mode</p>
<hr />
<div>= Автоматическое удаление снимков =<br />
<br />
== Обзор ==<br />
<br />
Удаление происходит раз в 24 часа (данное время можно задать при запуске сервера опцией <code>--snapshots-cleanup-period</code>, либо в конфигурационном файле, либо переменной окружения <code>SVACER_CLEANUP_SNAPSHOTS_PERIOD</code>), первое удаление всех подходящих снимков будет через указанное время после запуска сервера.<br />
<br />
Применять может только пользователь с доступом '''ServerOperations'''.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление самых старых по времени создания подходящих снимков и заносится отметка в таблицу удаленных снимков и в системный журнал. Также информация о удалении через cleanup вносится в системный журнал.<br />
<br />
== Добавление нового правила удаления ==<br />
<br />
svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --keep-time <nowiki><time></nowiki> --max-snapshots <max><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех проектов)<br />
* <code>--branch</code> — ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--keep-time</code> — время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней). '''Игнорируется, если <code>--max-snapshots > 0</code>'''<br />
* <code>--min-snapshots</code> — количество снимков, которое необходимо оставлять в ветке, подходящей под паттерн project + branch. По умолчанию 0<br />
<br />
=== Шаблоны и паттерны ===<br />
<br />
Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:<br />
<br />
'''1. Имя или ID:'''<br />
--project "MyProject"<br />
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта<br />
<br />
'''2. <code>*</code> (любое количество любых символов):'''<br />
--project "Dev*" # DevProject, Development<br />
--branch "*test*" # test, my-test, testing<br />
--snapshot "nightly-*"<br />
<br />
'''3. Регулярные выражения (с префиксом <code>re:</code>):'''<br />
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5<br />
--branch "re:^feature/[0-9]+$" # feature/123<br />
<br />
== Добавление запрета на удаление ==<br />
<br />
svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --min-snapshots <min><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> — проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех проектов)<br />
<br />
* <code>--branch</code> — ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> — снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.<br />
<br />
== Удаление правила ==<br />
<br />
svacer server cleanup delete --user <user> --password <password> --id <config id><br />
<br />
Где:<br />
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)<br />
<br />
== Вывести таблицу ==<br />
<br />
svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json><br />
<br />
Где:<br />
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков<br />
<br />
* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат<br />
== Запуск очистки вручную ==<br />
<br />
svacer server cleanup run --user <user> --password <password><br />
<br />
Запускает процесс очистки немедленно (вне расписания).<br />
<br />
== Примеры ==<br />
<br />
=== Добавление нового правила ===<br />
<br />
'''Правило 1: Удаление по времени'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --keep-time "240h"<br />
<br />
Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".<br />
<br />
'''Правило 2: Ограничение количества'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 20<br />
<br />
В любом проекте, в ветке "main" всегда будет не более 20 снимков, остальные будут удаляться.<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*"<br />
<br />
Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются правилами cleanup'''.<br />
<br />
=== Вывод таблицы правил ===<br />
<br />
svacer server cleanup list --user admin --password admin --type rule<br />
<br />
[[File:Cleanup rules table.png|center|thumb|1006x1006px]]<br />
<br />
=== Вывод таблицы запретов ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule<br />
[[File:Cleanup exclude rule table.png|center|thumb|1009x1009px]]<br />
<br />
=== Вывод в JSON формате ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule --format json<br />
<br />
Вывод:<br />
<br />
[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]<br />
<br />
=== Удаление правила ===<br />
<br />
svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416<br />
<br />
=== Использование regex ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --keep-time 168h<br />
<br />
Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code><br>Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code><br />
<br />
=== Regex синтаксис ===<br />
<br />
{| class="wikitable"<br />
! Паттерн !! Описание !! Пример<br />
|-<br />
| <code>^</code> || Начало строки || <code>^test</code><br />
|-<br />
| <code>[^x]</code> || Отрицание символов || <code>^[^m].*$</code><br />
|-<br />
| <code>$</code> || Конец строки || <code>test$</code><br />
|-<br />
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c<br />
|-<br />
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123<br />
|-<br />
| <code>.+</code> || Один или более || <code>test.+</code> → test-1<br />
|-<br />
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9<br />
|-<br />
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc<br />
|-<br />
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC<br />
|-<br />
| <code>(a&#124;b)</code> || "a" или "b" || <code>(test&#124;prod)</code><br />
|-<br />
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code><br />
|}<br />
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.<br />
<br />
Для правил отрицания конкретного элемента возможно использовать сложные правила, например:<br />
<br />
<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code><br />
<br />
Данное правило выбирает все ветки, кроме <code>main</code>.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3152Help:CLI/cleanup2025-10-17T09:37:08Z<p>Gribunin: add info cleanup</p>
<hr />
<div>= Автоматическое удаление снимков =<br />
<br />
== Обзор ==<br />
<br />
Удаление происходит раз в 24 часа (данное время можно задать при запуске сервера опцией <code>--snapshots-cleanup-period</code>, либо в конфигурационном файле, либо переменной окружения <code>SVACER_CLEANUP_SNAPSHOTS_PERIOD</code>), первое удаление всех подходящих снимков будет через указанное время после запуска сервера.<br />
<br />
Применять может только пользователь с доступом '''ServerOperations'''.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление и заносится отметка в таблицу удаленных снимков. Также информация о удалении через cleanup вносится в системный журнал.<br />
<br />
== Добавление нового правила удаления ==<br />
<br />
svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --keep-time <nowiki><time> </nowiki><time>--max-snapshots <max><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> - проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--branch</code> - ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--snapshot</code> - снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--keep-time</code> - время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней). '''Игнорируется, если <code>--max-snapshots > 0</code>'''<br />
* <code>--max-snapshots</code> - верхняя граница по количеству снимков в ветке. При значении = 0 данное правило не работает. При значении > 0 '''игнорирует''' '''<code>--keep-time</code>'''. По умолчанию 0<br />
<br />
=== Логика работы <code>--max-snapshots</code> ===<br />
<br />
'''MAX устанавливает верхнюю границу по количеству снимков в ветке:'''<br />
* Считает '''все''' снимки в ветке (total) если хотя бы один из снимков подходит под <code>project\branch\snapshot</code><br />
* Если <code>total > MAX</code>, удаляет <code>(total - MAX)</code> самых старых снимков<br />
* Удаляет '''только''' снимки, подходящие под паттерн <code>project\branch\snapshot</code><br />
* При <code>MAX = 0</code> данное правило не работает<br />
<br />
'''Примеры:'''<br />
<br />
Пример 1: Только TIME<br />
10 снимков в ветке, 5 старше 24h<br />
Правило: --keep-time 24h --max-snapshots 0<br />
Результат: Удалит 5 старых снимков (>24h), останется 5<br />
<br />
Пример 2: Только MAX<br />
10 снимков в ветке<br />
Правило: --max-snapshots 5<br />
Результат: Удалит 5 самых старых, оставит 5 новейших<br />
<br />
Пример 3: MAX игнорирует TIME<br />
10 снимков, 5 старше 24h, 5 новых <24h<br />
Правило: --keep-time 24h --max-snapshots 8<br />
Результат: <br />
TIME игнорируется. Применяется ТОЛЬКО MAX<br />
Удалит 2 самых старых и останется 8 (MAX)<br />
<br />
Пример 4: Scoped правило с MAX<br />
10 снимков: 6 nightly-*, 4 regular-*<br />
Правило: --snapshot "nightly-*" --max-snapshots 8<br />
Результат:<br />
total = 10 > MAX=8, нужно удалить 2<br />
Удалит 2 самых старых ТОЛЬКО из nightly-*<br />
Останется: 4 nightly-* + 4 regular-* = 8 снимков<br />
<br />
=== Шаблоны и паттерны ===<br />
<br />
Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:<br />
<br />
'''1. Имя или ID:'''<br />
--project "MyProject"<br />
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта<br />
<br />
'''2. <code>*</code> (любое количество любых символов):'''<br />
--project "Dev*" # DevProject, Development<br />
--branch "*test*" # test, my-test, testing<br />
--snapshot "nightly-*"<br />
<br />
'''3. Регулярные выражения (с префиксом <code>re:</code>):'''<br />
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5<br />
--branch "re:^feature/[0-9]+$" # feature/123<br />
<br />
== Добавление запрета на удаление ==<br />
<br />
svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --min-snapshots <min><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> - проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех веток)<br />
<br />
* <code>--branch</code> - ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> - снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--min-snapshots</code> - нижняя граница по количеству снимков в ветке. По умолчанию '''0''' <br />
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.<br />
<br />
=== Логика работы <code>--min-snapshots</code> ===<br />
<br />
'''MIN устанавливает нижнюю границу по количеству снимков в ветке:'''<br />
<br />
'''Значение = 0''' — '''полный запрет на удаление:'''<br />
* Снимки, подходящие под паттерн <code>project\branch\snapshot</code>, '''никогда не удаляются'''<br />
* Применяется индивидуально к каждому снимку<br />
<br />
'''Значение > 0''' — '''минимальное количество в ветке:'''<br />
* Правило применяется ко '''всей ветке''', если хотя бы один снимок подходит под паттерн<br />
* Пока <code>total_snapshots ≤ MIN</code>, в ветке '''ничего не удаляется'''<br />
* После того как <code>total > MIN</code>, можно удалить до <code>(total - MIN)</code> снимков<br />
<br />
'''Важные моменты:'''<br />
* При множественных запретах для одной ветки берется '''МАКСИМАЛЬНОЕ''' значение MIN<br />
* MIN '''всегда''' имеет приоритет над MAX<br />
* Если MIN=5 и MAX=3, то в ветке останется 5 снимков (MIN побеждает)<br />
<br />
'''Примеры:'''<br />
<br />
Пример 1: MIN<br />
Правило: --min-snapshots 5<br />
Ветка имеет 10 снимков<br />
Результат: Можно удалить до 5 снимков (10 - 5 = 5)<br />
<br />
Пример 2: MIN с паттерном<br />
Правило: --snapshot "release-*" --min-snapshots 3<br />
Ветка имеет 8 снимков (включая 2 release-*)<br />
Результат: <br />
- Хотя бы 1 release-* есть → MIN=3 применяется ко ВСЕЙ ветке<br />
- Можно удалить до 5 снимков (8 - 3 = 5)<br />
<br />
Пример 3: MIN=0<br />
Правило: --snapshot "important-*" --min-snapshots 0<br />
Ветка имеет 10 снимков (2 important-*, 8 других)<br />
Результат:<br />
- important-* НИКОГДА не удаляются<br />
- Остальные 8 могут быть удалены<br />
<br />
Пример 4: Множественные MIN<br />
Правило 1: --snapshot "*" --min-snapshots 3<br />
Правило 2: --snapshot "release-*" --min-snapshots 5<br />
Ветка имеет 10 снимков (включая release-*)<br />
Результат: MIN = 5 (максимальное), можно удалить до 5 снимков<br />
<br />
== Удаление правила ==<br />
<br />
svacer server cleanup delete --user <user> --password <password> --id <config id><br />
<br />
Где:<br />
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)<br />
<br />
== Вывести таблицу ==<br />
<br />
svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json><br />
<br />
Где:<br />
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков<br />
<br />
* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат<br />
== Запуск очистки вручную ==<br />
<br />
svacer server cleanup run --user <user> --password <password><br />
<br />
Запускает процесс очистки немедленно (вне расписания).<br />
<br />
== Примеры ==<br />
<br />
=== Добавление нового правила ===<br />
<br />
'''Правило 1: Удаление по времени'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --keep-time "240h" --max-snapshots 0<br />
<br />
Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".<br />
<br />
'''Правило 2: Ограничение количества (MAX mode)'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --max-snapshots 20<br />
<br />
В любом проекте, в ветке "main" всегда будет максимум 20 снимков (независимо от возраста).<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*" --min-snapshots 0<br />
<br />
Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются'''.<br />
<br />
=== Вывод таблицы правил ===<br />
<br />
svacer server cleanup list --user admin --password admin --type rule<br />
<br />
[[File:Cleanup rules table.png|center|thumb|1006x1006px]]<br />
<br />
=== Вывод таблицы запретов ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule<br />
[[File:Cleanup exclude rule table.png|center|thumb|1009x1009px]]<br />
<br />
=== Вывод в JSON формате ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule --format json<br />
<br />
Вывод:<br />
<br />
[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]<br />
<br />
=== Удаление правила ===<br />
<br />
svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416<br />
<br />
=== Защита важных снимков ===<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "*" --branch "*" --snapshot "*release*" --min-snapshots 0<br />
<br />
Снимки <code>*release*</code> никогда не удаляются.<br />
<br />
=== Ограничение количества снимков ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --max-snapshots 20<br />
<br />
В ветке main хранить максимум 20 снимков.<br />
<br />
=== Комбинация MIN и MAX ===<br />
<br />
'''Минимум 5 снимков'''<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 5<br />
<br />
'''Максимум 20 снимков'''<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --max-snapshots 20<br />
<br />
Результат: в ветке main всегда будет от 5 до 20 снимков.<br />
<br />
=== Использование regex ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --keep-time 168h --max-snapshots 0<br />
<br />
Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code><br>Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code><br />
<br />
=== Regex синтаксис ===<br />
<br />
{| class="wikitable"<br />
! Паттерн !! Описание !! Пример<br />
|-<br />
| <code>^</code> || Начало строки || <code>^test</code><br />
|-<br />
|[^x]<br />
|Отрицание символов<br />
|^[^m].*$<br />
|-<br />
| <code>$</code> || Конец строки || <code>test$</code><br />
|-<br />
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c<br />
|-<br />
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123<br />
|-<br />
| <code>.+</code> || Один или более || <code>test.+</code> → test-1<br />
|-<br />
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9<br />
|-<br />
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc<br />
|-<br />
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC<br />
|-<br />
| <code>(a&#124;b)</code> || "a" или "b" || <code>(test&#124;prod)</code><br />
|-<br />
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code><br />
|}<br />
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.<br />
<br />
Для правил отрицания конкретного элемента возможно использовать сложные правила, например:<br />
<br />
<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code><br />
<br />
Данное правило выбирает все ветки, кроме <code>main</code>.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Release_notes_12-0-0&diff=3151Release notes 12-0-02025-10-15T14:07:42Z<p>Gribunin: /* Автоочистка снимков/веток/проектов */ добавил ссылку на клинап</p>
<hr />
<div><br />
= Разметка маркеров с помощью AI =<br />
Добавлена возможность разметки маркеров с помощью ассистента AI, который на основании модели, обученной на множестве размеченных данных, предсказывает статус разметки маркера False Positive или Confirmed. <br />
<br />
Если пользователь применяет предсказанный статус маркера, то к маркеру автоматически добавляется комментарий с информацией о дате разметки, используемой модели AI и уровне доверия, также маркеру добавляется метка '''AI'''.<br />
<br />
'''Примечание''': прогнозируемый ассистентом AI статус разметки маркера носит рекомендательный характер. Окончательное решение о применении предсказанного моделью статуса остается за пользователем.<br />
<br />
Форма разметки с помощью AI открывается путем активации параметра '''Режим разметки с помощью AI''' на стандартных формах разметки маркера или групповой разметки маркера.<br />
<br />
Если текущий статус разметки маркера совпадает со статусом, предсказанным моделью AI, то такой маркер повторно разметить с помощью AI нельзя.<br />
<br />
[[File:Review marker-1.png|thumb|none|x250px|Форма разметки одного маркера]]<br />
<br />
[[File:Review marker-2.png|thumb|none|x250px|Форма групповой разметки маркеров]]<br />
<br />
= Изменения в пользовательских фильтрах =<br />
В пользовательских фильтрах реализованы дополнительные возможности фильтрации маркеров:<br />
<br />
1. Атрибут «'''Период последнего изменения'''» для фильтрации маркеров по дате (периоду) актуальной разметки.<br />
<br />
2. Поле ввода шаблона расширенного фильтра для фильтрации маркеров по сложным предикатам таким как:<br />
<br />
* поля маркера, его трассы, разметки и комментариев;<br />
* информацию из контекста (имя проекта, ветки, снимка и т.п.);<br />
* атрибуты снимка (включая пользовательские атрибуты, заданные при импорте);<br />
* статусы разметки;<br />
* текст и атрибуты комментариев.<br />
<br />
Описание, как составить выражение для расширенного фильтра, можно получить кликнув на [[File:icon_question_mark2.png|x25px]].<br />
[[File:Custom filter v12.png|thumb|none|x450px]]<br />
<br />
= Изменения в разделе '''Поиск''' =<br />
В разделе '''Поиск''' выполнены следующие доработки:<br />
<br />
1. Реализована возможность просмотра информации о маркере непосредственно в разделе '''Поиск'''.<br />
[[File:Search-1.png|thumb|none|upright=4]]<br />
<br />
<br />
<br />
2. Поиск маркеров по полям расширен дополнительными атрибутами:<br />
<br />
* Инвариант маркера;<br />
* ID маркера.<br />
<br />
[[File:Search-2.png|thumb|none|upright=4]]<br />
<br />
= Изменения на вкладке с исходным кодом файла =<br />
1. Панель функций перенесена на верх вкладки с файлом исходного кода.<br />
<br />
2. Добавлена функция добавления файла в фильтр по файлам, а также исключения файла из фильтра, если он был добавлен ранее.<br />
[[File:Cove view.png|thumb|none|upright=4.5]]<br />
<br />
= Сравнение маркеров при их сопоставлении =<br />
В процессе сопоставления маркеров реализована возможность сравнения маркеров. Это помогает пользователю определить причину, почему при импорте снимка маркеры не сопоставились автоматически.<br />
[[File:Match markers-1.png|thumb|none|upright=3.5]]<br />
<br />
Форма сравнения маркеров открывается в отдельном диалоговом окне.<br />
[[File:Match markers-2.png|thumb|none|upright=3.5]]<br />
<br />
= Просмотр JSON маркера =<br />
В дополнении к команде копирования JSON маркера добавлена команда просмотра JSON маркера в таблице маркеров и правой панели.<br />
[[File:JSON-1.png|thumb|none|upright=3.5]]<br />
<br />
Просмотр JSON осуществляется в отдельном диалоговом окне.<br />
[[File:JSON-2.png|thumb|none|upright=3.5]]<br />
<br />
= Изменения в разделе '''Проекты''' =<br />
1. Фокусировка на ветке master при создании нового проекта.<br />
<br />
2. В действия над снимком в списке снимков добавлена команда экспорта кода с разметкой. Все команды экспорта снимка вынесены в отдельное меню.<br />
[[File:Project 1.png|thumb|none|upright=4]]<br />
<br />
= Редактирование маркеров при импорте =<br />
<br />
При импорте .svace-dir, SARIF или snap-файла добавлена возможность (опция) задать правила трансформации, пропуска и дедупликации маркеров. Правила задаются в JSON-формате. <br />
<br />
При импорте в CLI данная опция называется edit-markers и позволяет указать путь к JSON-файлу с правилами. Подробнее здесь [[Edit markers (command line)]]. <br />
<br />
В пользовательском интерфейсе при импорте .svace-dir или SARIF возможно задать данную опцию и в ней указать путь к JSON-файлу в архиве .svace-dir или SARIF. А при импорте snap-файла возможно как подгрузить JSON-файл так и ввести выражение в формате JSON в поле ввода. <br />
<br />
[[File:Edit markers svace-dir.png|thumb|none|upright=3|Форма импорта .svace-dir]]<br />
[[File:Edit_markers_sarif.png|thumb|none|upright=3|Форма импорта SARIF]]<br />
[[File:Edit markers snap.png|thumb|none|upright=3|Форма импорта snap-файла]]<br />
<br />
= Добавлена форма управления асинхронными задачами =<br />
В разделе '''Настройки -> Асинхронные задачи''', где доступен просмотр и управление (отмена и откат) следующими асинхронными операциями:<br />
<br />
* Экспорт snap-файлов;<br />
* Экспорт SARIF;<br />
* Копирование снимков.<br />
<br />
Пользователь с серверным доступом '''Администрирование сервера''' может просматривать и управлять запущенными или выполненными асинхронными задачами всех юзеров. Пользователю без данного доступа доступно управление только своими асинхронные задачами.<br />
<br />
[[File:Async tasks.png|thumb|none|upright=4|Форма Асинхронные задачи]]<br />
<br />
'''Примечание''': в следующем релизе планируем интегрировать в данный раздел оставшиеся асинхронные операции, которые запускаются пользователями, а именно:<br />
<br />
* Импорт snapshot;<br />
* Импорт svace-dir;<br />
* Импорт SARIF;<br />
* Копирование проекта;<br />
* Копирование ветки.<br />
<br />
= Изменения в разделе '''Информация о сервере''' =<br />
В разделе '''Настройки -> Информация о сервере''', который доступен пользователям с серверным доступом '''Администрирование сервера''', представление информации разделено на три вкладки:<br />
<br />
* Параметры;<br />
* Системный лог;<br />
* Системный журнал.<br />
<br />
Т.к. системный лог может иметь большой размер, то вывод информации на форме ограничен последними 1Мб (значение регулируется переменной окружения SVACER_TAIL_LOG_SIZE). Скачивание лога позволяет выгрузить файл полностью.<br />
<br />
[[File:Server info-1.png|thumb|none|upright=4|Информация о сервере - вкладка Параметры]]<br />
[[File:Server info-2.png|thumb|none|upright=4|Информация о сервере - вкладка Системный лог]]<br />
[[File:Server info-3.png|thumb|none|upright=4|Информация о сервере - вкладка Системный журнал]]<br />
<br />
= Лицензирование Svacer =<br />
Реализован механизм лицензирования. Просмотр и применение лицензии доступно в CLI, а также в UI, где добавлен раздел Лицензия. Просмотр лицензии доступен всем пользователям, а активация лицензии доступна пользователям с серверным доступом «Администрирование сервера».<br />
<br />
[[File:Licence.png|thumb|none|upright=3.5]]<br />
<br />
'''Примечание''': функциональность добавлена для возможности будущего развития продукта. В дистрибутив Svacer v.12 лицензия встроена и не вносит никаких ограничений. Срок действия встроенной лицензии до 31.12.2027.<br />
<br />
= Парольная политика =<br />
Реализована возможность в конфигурационном файле задать парольную политику:<br />
<br />
1. Механизм установки минимальной сложности паролей.<br />
<br />
Пример задания конфигурационных настроек:<br />
<code>auth:<br />
svacer:<br />
password:<br />
min_length: 10<br />
complexity:<br />
- "[a-z]"<br />
- "[A-Z]"<br />
- "[0-9]"<br />
- "[!#]"</code><br />
В поле min_length - минимальная длина пароля. В поле complexity список регулярных выражений, задающих группу требуемых символов. В примере требуется наличие строчных, заглавных букв, цифр и спец символов - !#.<br />
<br />
2. Механизм блокировки учетной записи пользователя при нескольких неудачных попытках авторизации.<br />
<br />
Пример задания конфигурационных настроек:<br />
<code>security:<br />
login:<br />
max_attempts: 5<br />
lock_time: 2m</code><br />
Т.е. учетная запись будет блокироваться на 2 минуты при 5 неудачных попытках авторизации.<br />
<br />
Также реализована команда CLI для разблокировки учетной записи пользователя:<br />
<code>svacer user-proiver unlock -login chernykov_sv</code><br />
<br />
= Открытие вкладки LDAP по умолчанию =<br />
Добавлен параметр конфигурации default. Если он true, то на странице авторизации в пользовательском интерфейсе по умолчанию будет отрываться вкладка Svacer, если false - то при наличии сконфигурированного LDAP по умолчанию будет открываться вкладка LDAP, иначе флаг default игнорируется<br />
<br />
Пример задания конфигурационных настроек:<br />
<code>auth:<br />
svacer:<br />
enabled: true<br />
default: false</code><br />
<br />
= Автоочистка снимков/веток/проектов =<br />
Расширены опции команды cleanup, вызываемой в CLI:<br />
<br />
* ??? - удалять пустые ветки;<br />
* ??? - удалять пустые проекты;<br />
* max-snapshots - верхняя граница по количеству снимков в ветке;<br />
* min-snapshots - нижняя граница по количеству снимков в ветке.<br />
Подробное описание функции и ее опций [[Help:CLI/cleanup]].<br />
<br />
= Веб-хуки для нотификаций =<br />
Реализован механизм веб-хуков для отправки нотификаций по API во внешние системы. Механизм настраивается в конфигурационном файле в секции webhook.<br />
<br />
Реализована отправка нотификаций по следующим событиям:<br />
<br />
* разметка маркера / групповая разметка маркеров;<br />
* добавление / обновление комментария маркера;<br />
<br />
* добавление / копирование / изменение / удаление контейнеров (группа / проект / бранч);<br />
* импорт / копирование / удаление / изменение снимков;<br />
<br />
* копирование разметки.<br />
<br />
Пример задания конфигурационных настроек:<br />
<code>webhook:<br />
enabled: true<br />
journalLength: 86400<br />
targets:<br />
- url: "<nowiki>https://swarm-mgr.home:8080/webhook</nowiki>"<br />
workersCount: 1<br />
enabled: true <br />
filter: "Type == 1 and Payload.Status != 'Undecided'"<br />
caCerts: ""<br />
retryCount: 1<br />
timeout: 500</code><br />
Управление механизмом осуществляется в CLI с помощью команд:<br />
<br />
* просмотра записей журнала отправки событий:<br />
<br />
<code>svacer server webhook journal</code><br />
<br />
* просмотр статистики по работе службы:<br />
<br />
<code>svacer server webhook stat</code></div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Release_notes_12-0-0&diff=3150Release notes 12-0-02025-10-15T14:06:26Z<p>Gribunin: /* Редактирование маркеров при импорте */ добавил ссылку на документацию по edit-markers в release notes</p>
<hr />
<div><br />
= Разметка маркеров с помощью AI =<br />
Добавлена возможность разметки маркеров с помощью ассистента AI, который на основании модели, обученной на множестве размеченных данных, предсказывает статус разметки маркера False Positive или Confirmed. <br />
<br />
Если пользователь применяет предсказанный статус маркера, то к маркеру автоматически добавляется комментарий с информацией о дате разметки, используемой модели AI и уровне доверия, также маркеру добавляется метка '''AI'''.<br />
<br />
'''Примечание''': прогнозируемый ассистентом AI статус разметки маркера носит рекомендательный характер. Окончательное решение о применении предсказанного моделью статуса остается за пользователем.<br />
<br />
Форма разметки с помощью AI открывается путем активации параметра '''Режим разметки с помощью AI''' на стандартных формах разметки маркера или групповой разметки маркера.<br />
<br />
Если текущий статус разметки маркера совпадает со статусом, предсказанным моделью AI, то такой маркер повторно разметить с помощью AI нельзя.<br />
<br />
[[File:Review marker-1.png|thumb|none|x250px|Форма разметки одного маркера]]<br />
<br />
[[File:Review marker-2.png|thumb|none|x250px|Форма групповой разметки маркеров]]<br />
<br />
= Изменения в пользовательских фильтрах =<br />
В пользовательских фильтрах реализованы дополнительные возможности фильтрации маркеров:<br />
<br />
1. Атрибут «'''Период последнего изменения'''» для фильтрации маркеров по дате (периоду) актуальной разметки.<br />
<br />
2. Поле ввода шаблона расширенного фильтра для фильтрации маркеров по сложным предикатам таким как:<br />
<br />
* поля маркера, его трассы, разметки и комментариев;<br />
* информацию из контекста (имя проекта, ветки, снимка и т.п.);<br />
* атрибуты снимка (включая пользовательские атрибуты, заданные при импорте);<br />
* статусы разметки;<br />
* текст и атрибуты комментариев.<br />
<br />
Описание, как составить выражение для расширенного фильтра, можно получить кликнув на [[File:icon_question_mark2.png|x25px]].<br />
[[File:Custom filter v12.png|thumb|none|x450px]]<br />
<br />
= Изменения в разделе '''Поиск''' =<br />
В разделе '''Поиск''' выполнены следующие доработки:<br />
<br />
1. Реализована возможность просмотра информации о маркере непосредственно в разделе '''Поиск'''.<br />
[[File:Search-1.png|thumb|none|upright=4]]<br />
<br />
<br />
<br />
2. Поиск маркеров по полям расширен дополнительными атрибутами:<br />
<br />
* Инвариант маркера;<br />
* ID маркера.<br />
<br />
[[File:Search-2.png|thumb|none|upright=4]]<br />
<br />
= Изменения на вкладке с исходным кодом файла =<br />
1. Панель функций перенесена на верх вкладки с файлом исходного кода.<br />
<br />
2. Добавлена функция добавления файла в фильтр по файлам, а также исключения файла из фильтра, если он был добавлен ранее.<br />
[[File:Cove view.png|thumb|none|upright=4.5]]<br />
<br />
= Сравнение маркеров при их сопоставлении =<br />
В процессе сопоставления маркеров реализована возможность сравнения маркеров. Это помогает пользователю определить причину, почему при импорте снимка маркеры не сопоставились автоматически.<br />
[[File:Match markers-1.png|thumb|none|upright=3.5]]<br />
<br />
Форма сравнения маркеров открывается в отдельном диалоговом окне.<br />
[[File:Match markers-2.png|thumb|none|upright=3.5]]<br />
<br />
= Просмотр JSON маркера =<br />
В дополнении к команде копирования JSON маркера добавлена команда просмотра JSON маркера в таблице маркеров и правой панели.<br />
[[File:JSON-1.png|thumb|none|upright=3.5]]<br />
<br />
Просмотр JSON осуществляется в отдельном диалоговом окне.<br />
[[File:JSON-2.png|thumb|none|upright=3.5]]<br />
<br />
= Изменения в разделе '''Проекты''' =<br />
1. Фокусировка на ветке master при создании нового проекта.<br />
<br />
2. В действия над снимком в списке снимков добавлена команда экспорта кода с разметкой. Все команды экспорта снимка вынесены в отдельное меню.<br />
[[File:Project 1.png|thumb|none|upright=4]]<br />
<br />
= Редактирование маркеров при импорте =<br />
<br />
При импорте .svace-dir, SARIF или snap-файла добавлена возможность (опция) задать правила трансформации, пропуска и дедупликации маркеров. Правила задаются в JSON-формате. <br />
<br />
При импорте в CLI данная опция называется edit-markers и позволяет указать путь к JSON-файлу с правилами. Подробнее здесь [[Edit markers (command line)]]. <br />
<br />
В пользовательском интерфейсе при импорте .svace-dir или SARIF возможно задать данную опцию и в ней указать путь к JSON-файлу в архиве .svace-dir или SARIF. А при импорте snap-файла возможно как подгрузить JSON-файл так и ввести выражение в формате JSON в поле ввода. <br />
<br />
[[File:Edit markers svace-dir.png|thumb|none|upright=3|Форма импорта .svace-dir]]<br />
[[File:Edit_markers_sarif.png|thumb|none|upright=3|Форма импорта SARIF]]<br />
[[File:Edit markers snap.png|thumb|none|upright=3|Форма импорта snap-файла]]<br />
<br />
= Добавлена форма управления асинхронными задачами =<br />
В разделе '''Настройки -> Асинхронные задачи''', где доступен просмотр и управление (отмена и откат) следующими асинхронными операциями:<br />
<br />
* Экспорт snap-файлов;<br />
* Экспорт SARIF;<br />
* Копирование снимков.<br />
<br />
Пользователь с серверным доступом '''Администрирование сервера''' может просматривать и управлять запущенными или выполненными асинхронными задачами всех юзеров. Пользователю без данного доступа доступно управление только своими асинхронные задачами.<br />
<br />
[[File:Async tasks.png|thumb|none|upright=4|Форма Асинхронные задачи]]<br />
<br />
'''Примечание''': в следующем релизе планируем интегрировать в данный раздел оставшиеся асинхронные операции, которые запускаются пользователями, а именно:<br />
<br />
* Импорт snapshot;<br />
* Импорт svace-dir;<br />
* Импорт SARIF;<br />
* Копирование проекта;<br />
* Копирование ветки.<br />
<br />
= Изменения в разделе '''Информация о сервере''' =<br />
В разделе '''Настройки -> Информация о сервере''', который доступен пользователям с серверным доступом '''Администрирование сервера''', представление информации разделено на три вкладки:<br />
<br />
* Параметры;<br />
* Системный лог;<br />
* Системный журнал.<br />
<br />
Т.к. системный лог может иметь большой размер, то вывод информации на форме ограничен последними 1Мб (значение регулируется переменной окружения SVACER_TAIL_LOG_SIZE). Скачивание лога позволяет выгрузить файл полностью.<br />
<br />
[[File:Server info-1.png|thumb|none|upright=4|Информация о сервере - вкладка Параметры]]<br />
[[File:Server info-2.png|thumb|none|upright=4|Информация о сервере - вкладка Системный лог]]<br />
[[File:Server info-3.png|thumb|none|upright=4|Информация о сервере - вкладка Системный журнал]]<br />
<br />
= Лицензирование Svacer =<br />
Реализован механизм лицензирования. Просмотр и применение лицензии доступно в CLI, а также в UI, где добавлен раздел Лицензия. Просмотр лицензии доступен всем пользователям, а активация лицензии доступна пользователям с серверным доступом «Администрирование сервера».<br />
<br />
[[File:Licence.png|thumb|none|upright=3.5]]<br />
<br />
'''Примечание''': функциональность добавлена для возможности будущего развития продукта. В дистрибутив Svacer v.12 лицензия встроена и не вносит никаких ограничений. Срок действия встроенной лицензии до 31.12.2027.<br />
<br />
= Парольная политика =<br />
Реализована возможность в конфигурационном файле задать парольную политику:<br />
<br />
1. Механизм установки минимальной сложности паролей.<br />
<br />
Пример задания конфигурационных настроек:<br />
<code>auth:<br />
svacer:<br />
password:<br />
min_length: 10<br />
complexity:<br />
- "[a-z]"<br />
- "[A-Z]"<br />
- "[0-9]"<br />
- "[!#]"</code><br />
В поле min_length - минимальная длина пароля. В поле complexity список регулярных выражений, задающих группу требуемых символов. В примере требуется наличие строчных, заглавных букв, цифр и спец символов - !#.<br />
<br />
2. Механизм блокировки учетной записи пользователя при нескольких неудачных попытках авторизации.<br />
<br />
Пример задания конфигурационных настроек:<br />
<code>security:<br />
login:<br />
max_attempts: 5<br />
lock_time: 2m</code><br />
Т.е. учетная запись будет блокироваться на 2 минуты при 5 неудачных попытках авторизации.<br />
<br />
Также реализована команда CLI для разблокировки учетной записи пользователя:<br />
<code>svacer user-proiver unlock -login chernykov_sv</code><br />
<br />
= Открытие вкладки LDAP по умолчанию =<br />
Добавлен параметр конфигурации default. Если он true, то на странице авторизации в пользовательском интерфейсе по умолчанию будет отрываться вкладка Svacer, если false - то при наличии сконфигурированного LDAP по умолчанию будет открываться вкладка LDAP, иначе флаг default игнорируется<br />
<br />
Пример задания конфигурационных настроек:<br />
<code>auth:<br />
svacer:<br />
enabled: true<br />
default: false</code><br />
<br />
= Автоочистка снимков/веток/проектов =<br />
Расширены опции команды cleanup, вызываемой в CLI:<br />
<br />
* ??? - удалять пустые ветки;<br />
* ??? - удалять пустые проекты;<br />
* max-snapshots - верхняя граница по количеству снимков в ветке;<br />
* min-snapshots - нижняя граница по количеству снимков в ветке.<br />
<br />
= Веб-хуки для нотификаций =<br />
Реализован механизм веб-хуков для отправки нотификаций по API во внешние системы. Механизм настраивается в конфигурационном файле в секции webhook.<br />
<br />
Реализована отправка нотификаций по следующим событиям:<br />
<br />
* разметка маркера / групповая разметка маркеров;<br />
* добавление / обновление комментария маркера;<br />
<br />
* добавление / копирование / изменение / удаление контейнеров (группа / проект / бранч);<br />
* импорт / копирование / удаление / изменение снимков;<br />
<br />
* копирование разметки.<br />
<br />
Пример задания конфигурационных настроек:<br />
<code>webhook:<br />
enabled: true<br />
journalLength: 86400<br />
targets:<br />
- url: "<nowiki>https://swarm-mgr.home:8080/webhook</nowiki>"<br />
workersCount: 1<br />
enabled: true <br />
filter: "Type == 1 and Payload.Status != 'Undecided'"<br />
caCerts: ""<br />
retryCount: 1<br />
timeout: 500</code><br />
Управление механизмом осуществляется в CLI с помощью команд:<br />
<br />
* просмотра записей журнала отправки событий:<br />
<br />
<code>svacer server webhook journal</code><br />
<br />
* просмотр статистики по работе службы:<br />
<br />
<code>svacer server webhook stat</code></div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Edit_markers_(command_line)&diff=3149Edit markers (command line)2025-10-15T14:03:02Z<p>Gribunin: edit-markers page</p>
<hr />
<div>== Обзор ==<br />
Функциональность '''edit-markers''' позволяет автоматически обрабатывать маркеры при импорте данных с помощью правил, заданных в JSON-файле. Поддерживаются три типа операций:<br />
<br />
* '''skip''' — пропуск (удаление) маркеров, соответствующих условию<br />
* '''change''' — изменение полей маркеров<br />
* '''deduplicate''' — объединение дублирующихся маркеров. У маркеров, подходящих под правило, объединяется трасса и остается только один (случайный) маркер с объединенной трассой, остальные маркеры удаляются.<br />
<br />
== Использование ==<br />
<br />
=== Импорт результатов Svace ===<br />
<code>svacer import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила редактирования к маркерам при импорте результатов анализа Svace.<br />
<br />
=== Импорт SARIF ===<br />
<code>svacer sarif2 import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при импорте SARIF-файлов.<br />
<br />
=== Загрузка подготовленных данных ===<br />
<code>svacer upload --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила при загрузке уже импортированных данных на сервер.<br />
<br />
=== Импорт снимка с редактированием ===<br />
<code>svacer server import --edit-markers <файл_правил.json> [другие опции]</code> <br />
<br />
Применяет правила к снимку при импорте. Дополнительно можно сохранить отредактированный снимок:<br />
<br />
<code>svacer server import --edit-markers rules.json --save-edited-snapshot edited_snapshot.snap</code><br />
<br />
== Формат файла правил ==<br />
Правила задаются в виде JSON-файла, содержащего массив объектов правил:<br />
[{<br />
"action": "тип_действия",<br />
"rules": "условие_или_список_полей",<br />
"change": { /* только для action: "change" */ }<br />
}]<br />
<br />
=== Типы действий ===<br />
<br />
==== skip — Пропуск маркеров ====<br />
Удаляет маркеры, соответствующие условию.<br />
{<br />
"action": "skip",<br />
"rules": "file == 'test.cpp' and line > 100"<br />
}<br />
<br />
==== change — Изменение маркеров ====<br />
Изменяет указанные поля маркеров.<br />
{<br />
<nowiki> </nowiki>"action": "change",<br />
<nowiki> </nowiki>"rules": "warnclass == 'UNREACHABLE_CODE'",<br />
<nowiki> </nowiki>"change": {<br />
<nowiki> </nowiki> "warnclass": "IGNORED",<br />
<nowiki> </nowiki> "msg": "Код помечен как недостижимый"<br />
<nowiki> </nowiki>}}<br />
Доступные поля для изменения: <code>warnclass</code>, <code>msg</code>, <code>lang</code>, <code>tool</code>, <code>file</code>, <code>details</code>, <code>line</code>, <code>mtid</code>, <code>function</code>.<br />
<br />
==== deduplicate — Дедупликация ====<br />
Объединяет маркеры с одинаковыми значениями указанных полей.<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
Поля для группировки (можно указать от 1 до 8): <code>file</code>, <code>line</code>, <code>function</code>, <code>warnclass</code>, <code>lang</code>, <code>tool</code>, <code>mtid</code>, <code>details</code>.<br />
<br />
== Доступные поля и операторы ==<br />
<br />
=== Поля маркеров ===<br />
В условиях можно использовать следующие поля:<br />
<br />
* <code>file</code> — путь к файлу (строка)<br />
* <code>line</code> — номер строки (число)<br />
* <code>function</code> — имя функции (строка)<br />
* <code>warnclass</code> — класс предупреждения (строка)<br />
* <code>lang</code> — язык программирования (строка)<br />
* <code>tool</code> — инструмент анализа (строка)<br />
* <code>mtid</code> — ID типа маркера (строка)<br />
* <code>msg</code> — сообщение маркера (строка)<br />
* <code>details</code> — детали маркера (строка)<br />
<br />
=== Операторы сравнения ===<br />
<br />
* <code>==</code>, <code>!=</code> — равно, не равно<br />
* <code>></code>, <code>>=</code>, <code><</code>, <code><=</code> — сравнение чисел<br />
* <code>and</code>, <code>or</code>, <code>&&</code>, <code>||</code> — логические операторы<br />
* <code>not</code>, <code>!</code> — логическое НЕ<br />
* <code>in</code> — проверка вхождения в список (например: <code>warnclass in ['ERROR', 'WARNING']</code>)<br />
* <code>contains</code> — проверка вхождения подстроки<br />
<br />
=== Функции для работы со строками ===<br />
<br />
* <code>icontains(s, substring)</code> — содержит подстроку (без учета регистра)<br />
* <code>hasPrefix(s, prefix)</code> — начинается с префикса<br />
* <code>hasSuffix(s, suffix)</code> — заканчивается суффиксом<br />
* <code>equalsFold(a, b)</code> — сравнение строк без учета регистра<br />
* <code>lower(s)</code> — преобразование в нижний регистр<br />
* <code>upper(s)</code> — преобразование в верхний регистр<br />
* <code>trim(s)</code> — удаление пробелов в начале и конце строки<br />
* <code>replace(s, old, new)</code> — замена всех вхождений подстроки<br />
* <code>regex(s, pattern)</code> — проверка соответствия регулярному выражению<br />
* <code>nregex(s, pattern)</code> — проверка НЕсоответствия регулярному выражению<br />
<br />
== Примеры ==<br />
<br />
=== Пропуск тестовых файлов ===<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'test') or icontains(file, 'spec')"<br />
}<br />
]<br />
<br />
=== Изменение класса предупреждений ===<br />
[<br />
{<br />
"action": "change",<br />
"rules": "warnclass == 'UNREACHABLE_CODE' and icontains(file, 'generated')",<br />
"change": {<br />
"warnclass": "INFO",<br />
"msg": "Недостижимый код в сгенерированном файле"<br />
}<br />
}<br />
]<br />
<br />
=== Удаление дубликатов ===<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass"<br />
}<br />
]<br />
<br />
=== Комплексный пример ===<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "file == '.build/src/generated.c'"<br />
},<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,function"<br />
},<br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['DEBUG', 'TRACE', 'INFO'] and line > 1000",<br />
"change": {<br />
"warnclass": "LOW_PRIORITY",<br />
"msg": "Низкоприоритетное предупреждение в длинном файле"<br />
}<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "regex(file, \".*_test\\\\.(c|cpp)$\")"<br />
}<br />
]<br />
<br />
=== Изменение приоритета для определенных классов ===<br />
Понижаем приоритет информационных сообщений:<br />
[ <br />
{<br />
"action": "change",<br />
"rules": "warnclass in ['UNREACHABLE_CODE.ENUM', 'UNREACHABLE_CODE.RET', 'UNUSED_VALUE.PARAM_ASSIGN']",<br />
"change": {<br />
"warnclass": "UNREACHABLE_CODE"<br />
}<br />
}<br />
]<br />
<br />
=== Обработка сгенерированных файлов ===<br />
Пропускаем все маркеры в сгенерированных файлах:<br />
<br />
[ <br />
{<br />
"action": "skip",<br />
"rules": "contains(file, 'generated') or contains(file, '.build') or hasPrefix(file, 'vendor/')"<br />
}<br />
]<br />
<br />
=== Дедупликация с последующей фильтрацией ===<br />
Сначала объединяем дубликаты, потом удаляем ненужные:<br />
[<br />
{<br />
"action": "deduplicate",<br />
"rules": "file,line,warnclass,function"<br />
},<br />
{<br />
"action": "skip",<br />
"rules": "icontains(file, 'third_party') or icontains(file, 'external')"<br />
}<br />
]<br />
<br />
=== Работа с регулярными выражениями ===<br />
Фильтрация по сложным паттернам путей:<br />
[<br />
{<br />
"action": "skip",<br />
"rules": "regex(file, \"^(tests?|spec|mock|stub)/.*$\") or nregex(file, \"^src/.*\\.(c|cpp|h|hpp)$\")"<br />
}<br />
]<br />
<br />
== Дополнительные опции ==<br />
<br />
=== Сохранение отредактированного снимка ===<br />
При импорте снимка можно сохранить результат применения правил:<br />
svacer server import --edit-markers rules.json --save-edited-snapshot result.snap ...<br />
Обязательно должно быть расширение <code>.snap</code> для сохранения.<br />
<br />
== Важные замечания ==<br />
<br />
# '''Порядок правил''' — правила применяются последовательно в порядке их описания в файле<br />
# '''Валидация''' — при загрузке правил проверяется корректность JSON и соответствие полей<br />
# '''Формат файла''' — файл правил должен иметь расширение <code>.json</code><br />
# '''Логирование''' — результат применения правил выводится в лог (количество обработанных и удаленных маркеров)<br />
# '''Поле line в change''' — должно быть строкой с положительным числом<br />
# '''Поле warnclass в change''' — может принимать только русские, английский буквы, цифры, а также специальные символы, которые находятся на цифровой панели клавиатуры (и печатаются через Shift)</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3148Help:CLI/cleanup2025-10-14T12:45:23Z<p>Gribunin: remove bug</p>
<hr />
<div>= Автоматическое удаление снимков =<br />
<br />
== Обзор ==<br />
<br />
Удаление происходит раз в 24 часа (данное время можно задать при запуске сервера опцией <code>--snapshots-cleanup-period</code>, либо в конфигурационном файле, либо переменной окружения <code>SVACER_CLEANUP_SNAPSHOTS_PERIOD</code>), первое удаление всех подходящих снимков будет через указанное время после запуска сервера.<br />
<br />
Применять может только пользователь с доступом '''ServerOperations'''.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление и заносится отметка в таблицу удаленных снимков.<br />
<br />
== Добавление нового правила удаления ==<br />
<br />
svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --keep-time <nowiki><time> </nowiki><time>--max-snapshots <max><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> - проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--branch</code> - ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--snapshot</code> - снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--keep-time</code> - время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней). '''Игнорируется, если <code>--max-snapshots > 0</code>'''<br />
* <code>--max-snapshots</code> - верхняя граница по количеству снимков в ветке. При значении = 0 данное правило не работает. При значении > 0 '''игнорирует''' '''<code>--keep-time</code>'''. По умолчанию 0<br />
<br />
=== Логика работы <code>--max-snapshots</code> ===<br />
<br />
'''MAX устанавливает верхнюю границу по количеству снимков в ветке:'''<br />
* Считает '''все''' снимки в ветке (total) если хотя бы один из снимков подходит под <code>project\branch\snapshot</code><br />
* Если <code>total > MAX</code>, удаляет <code>(total - MAX)</code> самых старых снимков<br />
* Удаляет '''только''' снимки, подходящие под паттерн <code>project\branch\snapshot</code><br />
* При <code>MAX = 0</code> данное правило не работает<br />
<br />
'''Примеры:'''<br />
<br />
Пример 1: Только TIME<br />
10 снимков в ветке, 5 старше 24h<br />
Правило: --keep-time 24h --max-snapshots 0<br />
Результат: Удалит 5 старых снимков (>24h), останется 5<br />
<br />
Пример 2: Только MAX<br />
10 снимков в ветке<br />
Правило: --max-snapshots 5<br />
Результат: Удалит 5 самых старых, оставит 5 новейших<br />
<br />
Пример 3: MAX игнорирует TIME<br />
10 снимков, 5 старше 24h, 5 новых <24h<br />
Правило: --keep-time 24h --max-snapshots 8<br />
Результат: <br />
TIME игнорируется. Применяется ТОЛЬКО MAX<br />
Удалит 2 самых старых и останется 8 (MAX)<br />
<br />
Пример 4: Scoped правило с MAX<br />
10 снимков: 6 nightly-*, 4 regular-*<br />
Правило: --snapshot "nightly-*" --max-snapshots 8<br />
Результат:<br />
total = 10 > MAX=8, нужно удалить 2<br />
Удалит 2 самых старых ТОЛЬКО из nightly-*<br />
Останется: 4 nightly-* + 4 regular-* = 8 снимков<br />
<br />
=== Шаблоны и паттерны ===<br />
<br />
Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:<br />
<br />
'''1. Имя или ID:'''<br />
--project "MyProject"<br />
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта<br />
<br />
'''2. <code>*</code> (любое количество любых символов):'''<br />
--project "Dev*" # DevProject, Development<br />
--branch "*test*" # test, my-test, testing<br />
--snapshot "nightly-*"<br />
<br />
'''3. Регулярные выражения (с префиксом <code>re:</code>):'''<br />
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5<br />
--branch "re:^feature/[0-9]+$" # feature/123<br />
<br />
== Добавление запрета на удаление ==<br />
<br />
svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --min-snapshots <min><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> - проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех веток)<br />
<br />
* <code>--branch</code> - ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> - снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--min-snapshots</code> - нижняя граница по количеству снимков в ветке. По умолчанию '''0''' <br />
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.<br />
<br />
=== Логика работы <code>--min-snapshots</code> ===<br />
<br />
'''MIN устанавливает нижнюю границу по количеству снимков в ветке:'''<br />
<br />
'''Значение = 0''' — '''полный запрет на удаление:'''<br />
* Снимки, подходящие под паттерн <code>project\branch\snapshot</code>, '''никогда не удаляются'''<br />
* Применяется индивидуально к каждому снимку<br />
<br />
'''Значение > 0''' — '''минимальное количество в ветке:'''<br />
* Правило применяется ко '''всей ветке''', если хотя бы один снимок подходит под паттерн<br />
* Пока <code>total_snapshots ≤ MIN</code>, в ветке '''ничего не удаляется'''<br />
* После того как <code>total > MIN</code>, можно удалить до <code>(total - MIN)</code> снимков<br />
<br />
'''Важные моменты:'''<br />
* При множественных запретах для одной ветки берется '''МАКСИМАЛЬНОЕ''' значение MIN<br />
* MIN '''всегда''' имеет приоритет над MAX<br />
* Если MIN=5 и MAX=3, то в ветке останется 5 снимков (MIN побеждает)<br />
<br />
'''Примеры:'''<br />
<br />
Пример 1: MIN<br />
Правило: --min-snapshots 5<br />
Ветка имеет 10 снимков<br />
Результат: Можно удалить до 5 снимков (10 - 5 = 5)<br />
<br />
Пример 2: MIN с паттерном<br />
Правило: --snapshot "release-*" --min-snapshots 3<br />
Ветка имеет 8 снимков (включая 2 release-*)<br />
Результат: <br />
- Хотя бы 1 release-* есть → MIN=3 применяется ко ВСЕЙ ветке<br />
- Можно удалить до 5 снимков (8 - 3 = 5)<br />
<br />
Пример 3: MIN=0<br />
Правило: --snapshot "important-*" --min-snapshots 0<br />
Ветка имеет 10 снимков (2 important-*, 8 других)<br />
Результат:<br />
- important-* НИКОГДА не удаляются<br />
- Остальные 8 могут быть удалены<br />
<br />
Пример 4: Множественные MIN<br />
Правило 1: --snapshot "*" --min-snapshots 3<br />
Правило 2: --snapshot "release-*" --min-snapshots 5<br />
Ветка имеет 10 снимков (включая release-*)<br />
Результат: MIN = 5 (максимальное), можно удалить до 5 снимков<br />
<br />
== Удаление правила ==<br />
<br />
svacer server cleanup delete --user <user> --password <password> --id <config id><br />
<br />
Где:<br />
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)<br />
<br />
== Вывести таблицу ==<br />
<br />
svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json><br />
<br />
Где:<br />
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков<br />
<br />
* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат<br />
== Запуск очистки вручную ==<br />
<br />
svacer server cleanup run --user <user> --password <password><br />
<br />
Запускает процесс очистки немедленно (вне расписания).<br />
<br />
== Примеры ==<br />
<br />
=== Добавление нового правила ===<br />
<br />
'''Правило 1: Удаление по времени'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --keep-time "240h" --max-snapshots 0<br />
<br />
Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".<br />
<br />
'''Правило 2: Ограничение количества (MAX mode)'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --max-snapshots 20<br />
<br />
В любом проекте, в ветке "main" всегда будет максимум 20 снимков (независимо от возраста).<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*" --min-snapshots 0<br />
<br />
Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются'''.<br />
<br />
=== Вывод таблицы правил ===<br />
<br />
svacer server cleanup list --user admin --password admin --type rule<br />
<br />
[[File:Cleanup rules table.png|center|thumb|1006x1006px]]<br />
<br />
=== Вывод таблицы запретов ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule<br />
[[File:Cleanup exclude rule table.png|center|thumb|1009x1009px]]<br />
<br />
=== Вывод в JSON формате ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule --format json<br />
<br />
Вывод:<br />
<br />
[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]<br />
<br />
=== Удаление правила ===<br />
<br />
svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416<br />
<br />
=== Защита важных снимков ===<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "*" --branch "*" --snapshot "*release*" --min-snapshots 0<br />
<br />
Снимки <code>*release*</code> никогда не удаляются.<br />
<br />
=== Ограничение количества снимков ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --max-snapshots 20<br />
<br />
В ветке main хранить максимум 20 снимков.<br />
<br />
=== Комбинация MIN и MAX ===<br />
<br />
'''Минимум 5 снимков'''<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 5<br />
<br />
'''Максимум 20 снимков'''<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --max-snapshots 20<br />
<br />
Результат: в ветке main всегда будет от 5 до 20 снимков.<br />
<br />
=== Использование regex ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --keep-time 168h --max-snapshots 0<br />
<br />
Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code><br>Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code><br />
<br />
=== Regex синтаксис ===<br />
<br />
{| class="wikitable"<br />
! Паттерн !! Описание !! Пример<br />
|-<br />
| <code>^</code> || Начало строки || <code>^test</code><br />
|-<br />
|[^x]<br />
|Отрицание символов<br />
|^[^m].*$<br />
|-<br />
| <code>$</code> || Конец строки || <code>test$</code><br />
|-<br />
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c<br />
|-<br />
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123<br />
|-<br />
| <code>.+</code> || Один или более || <code>test.+</code> → test-1<br />
|-<br />
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9<br />
|-<br />
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc<br />
|-<br />
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC<br />
|-<br />
| <code>(a&#124;b)</code> || "a" или "b" || <code>(test&#124;prod)</code><br />
|-<br />
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code><br />
|}<br />
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.<br />
<br />
Для правил отрицания конкретного элемента возможно использовать сложные правила, например:<br />
<br />
<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code><br />
<br />
Данное правило выбирает все ветки, кроме <code>main</code>.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3124Help:CLI/cleanup2025-10-13T17:26:22Z<p>Gribunin: add more info about cleanup</p>
<hr />
<div>= Автоматическое удаление снимков =<br />
<br />
== Обзор ==<br />
<br />
Удаление происходит раз в 24 часа (данное время можно задать при запуске сервера опцией <code>--snapshots-cleanup-period</code>, либо в конфигурационном файле, либо переменной окружения <code>SVACER_CLEANUP_SNAPSHOTS_PERIOD</code>), первое удаление всех подходящих снимков будет через указанное время после запуска сервера.<br />
<br />
Применять может только пользователь с доступом '''ServerOperations'''.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление и заносится отметка в таблицу удаленных снимков.<br />
<br />
== Добавление нового правила удаления ==<br />
<br />
svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --keep-time <nowiki><time> </nowiki><time>--max-snapshots <max><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> - проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--branch</code> - ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--snapshot</code> - снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--keep-time</code> - время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней). '''Игнорируется, если <code>--max-snapshots > 0</code>'''<br />
* <code>--max-snapshots</code> - верхняя граница по количеству снимков в ветке. При значении = 0 данное правило не работает. При значении > 0 '''игнорирует''' '''<code>--time</code>'''. По умолчанию 0<br />
<br />
=== Логика работы <code>--max-snapshots</code> ===<br />
<br />
'''MAX устанавливает верхнюю границу по количеству снимков в ветке:'''<br />
* Считает '''все''' снимки в ветке (total) если хотя бы один из снимков подходит под <code>project\branch\snapshot</code><br />
* Если <code>total > MAX</code>, удаляет <code>(total - MAX)</code> самых старых снимков<br />
* Удаляет '''только''' снимки, подходящие под паттерн <code>project\branch\snapshot</code><br />
* При <code>MAX = 0</code> данное правило не работает<br />
<br />
'''Примеры:'''<br />
<br />
Пример 1: Только TIME<br />
10 снимков в ветке, 5 старше 24h<br />
Правило: --keep-time 24h --max-snapshots 0<br />
Результат: Удалит 5 старых снимков (>24h), останется 5<br />
<br />
Пример 2: Только MAX<br />
10 снимков в ветке<br />
Правило: --max-snapshots 5<br />
Результат: Удалит 5 самых старых, оставит 5 новейших<br />
<br />
Пример 3: MAX игнорирует TIME<br />
10 снимков, 5 старше 24h, 5 новых <24h<br />
Правило: --keep-time 24h --max-snapshots 8<br />
Результат: <br />
TIME игнорируется. Применяется ТОЛЬКО MAX<br />
Удалит 2 самых старых и останется 8 (MAX)<br />
<br />
Пример 4: Scoped правило с MAX<br />
10 снимков: 6 nightly-*, 4 regular-*<br />
Правило: --snapshot "nightly-*" --max-snapshots 8<br />
Результат:<br />
total = 10 > MAX=8, нужно удалить 2<br />
Удалит 2 самых старых ТОЛЬКО из nightly-*<br />
Останется: 4 nightly-* + 4 regular-* = 8 снимков<br />
<br />
=== Шаблоны и паттерны ===<br />
<br />
Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:<br />
<br />
'''1. Имя или ID:'''<br />
--project "MyProject"<br />
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта<br />
<br />
'''2. <code>*</code> (любое количество любых символов):'''<br />
--project "Dev*" # DevProject, Development<br />
--branch "*test*" # test, my-test, testing<br />
--snapshot "nightly-*"<br />
<br />
'''3. Регулярные выражения (с префиксом <code>re:</code>):'''<br />
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5<br />
--branch "re:^feature/[0-9]+$" # feature/123<br />
<br />
== Добавление запрета на удаление ==<br />
<br />
svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --min-snapshots <min><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> - проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех веток)<br />
<br />
* <code>--branch</code> - ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> - снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--min-snapshots</code> - нижняя граница по количеству снимков в ветке. По умолчанию '''0''' <br />
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.<br />
<br />
=== Логика работы <code>--min-snapshots</code> ===<br />
<br />
'''MIN устанавливает нижнюю границу по количеству снимков в ветке:'''<br />
<br />
'''Значение = 0''' — '''полный запрет на удаление:'''<br />
* Снимки, подходящие под паттерн <code>project\branch\snapshot</code>, '''никогда не удаляются'''<br />
* Применяется индивидуально к каждому снимку<br />
<br />
'''Значение > 0''' — '''минимальное количество в ветке:'''<br />
* Правило применяется ко '''всей ветке''', если хотя бы один снимок подходит под паттерн<br />
* Пока <code>total_snapshots ≤ MIN</code>, в ветке '''ничего не удаляется'''<br />
* После того как <code>total > MIN</code>, можно удалить до <code>(total - MIN)</code> снимков<br />
<br />
'''Важные моменты:'''<br />
* При множественных запретах для одной ветки берется '''МАКСИМАЛЬНОЕ''' значение MIN<br />
* MIN '''всегда''' имеет приоритет над MAX<br />
* Если MIN=5 и MAX=3, то в ветке останется 5 снимков (MIN побеждает)<br />
<br />
'''Примеры:'''<br />
<br />
Пример 1: MIN<br />
Правило: --min-snapshots 5<br />
Ветка имеет 10 снимков<br />
Результат: Можно удалить до 5 снимков (10 - 5 = 5)<br />
<br />
Пример 2: MIN с паттерном<br />
Правило: --snapshot "release-*" --min-snapshots 3<br />
Ветка имеет 8 снимков (включая 2 release-*)<br />
Результат: <br />
- Хотя бы 1 release-* есть → MIN=3 применяется ко ВСЕЙ ветке<br />
- Можно удалить до 5 снимков (8 - 3 = 5)<br />
<br />
Пример 3: MIN=0<br />
Правило: --snapshot "important-*" --min-snapshots 0<br />
Ветка имеет 10 снимков (2 important-*, 8 других)<br />
Результат:<br />
- important-* НИКОГДА не удаляются<br />
- Остальные 8 могут быть удалены<br />
<br />
Пример 4: Множественные MIN<br />
Правило 1: --snapshot "*" --min-snapshots 3<br />
Правило 2: --snapshot "release-*" --min-snapshots 5<br />
Ветка имеет 10 снимков (включая release-*)<br />
Результат: MIN = 5 (максимальное), можно удалить до 5 снимков<br />
<br />
== Удаление правила ==<br />
<br />
svacer server cleanup delete --user <user> --password <password> --id <config id><br />
<br />
Где:<br />
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)<br />
<br />
== Вывести таблицу ==<br />
<br />
svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json><br />
<br />
Где:<br />
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков<br />
<br />
* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат<br />
== Запуск очистки вручную ==<br />
<br />
svacer server cleanup run --user <user> --password <password><br />
<br />
Запускает процесс очистки немедленно (вне расписания).<br />
<br />
== Примеры ==<br />
<br />
=== Добавление нового правила ===<br />
<br />
'''Правило 1: Удаление по времени'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --keep-time "240h" --max-snapshots 0<br />
<br />
Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".<br />
<br />
'''Правило 2: Ограничение количества (MAX mode)'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --max-snapshots 20<br />
<br />
В любом проекте, в ветке "main" всегда будет максимум 20 снимков (независимо от возраста).<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*" --min-snapshots 0<br />
<br />
Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются'''.<br />
<br />
=== Вывод таблицы правил ===<br />
<br />
svacer server cleanup list --user admin --password admin --type rule<br />
<br />
[[File:Cleanup rules table.png|center|thumb|1006x1006px]]<br />
<br />
=== Вывод таблицы запретов ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule<br />
[[File:Cleanup exclude rule table.png|center|thumb|1009x1009px]]<br />
<br />
=== Вывод в JSON формате ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule --format json<br />
<br />
Вывод:<br />
<br />
[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]<br />
<br />
=== Удаление правила ===<br />
<br />
svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416<br />
<br />
=== Защита важных снимков ===<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "*" --branch "*" --snapshot "*release*" --min-snapshots 0<br />
<br />
Снимки <code>*release*</code> никогда не удаляются.<br />
<br />
=== Ограничение количества снимков ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --max-snapshots 20<br />
<br />
В ветке main хранить максимум 20 снимков.<br />
<br />
=== Комбинация MIN и MAX ===<br />
<br />
'''Минимум 5 снимков'''<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 5<br />
<br />
'''Максимум 20 снимков'''<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --max-snapshots 20<br />
<br />
Результат: в ветке main всегда будет от 5 до 20 снимков.<br />
<br />
=== Использование regex ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --keep-time 168h --max-snapshots 0<br />
<br />
Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code><br>Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code><br />
<br />
=== Regex синтаксис ===<br />
<br />
{| class="wikitable"<br />
! Паттерн !! Описание !! Пример<br />
|-<br />
| <code>^</code> || Начало строки || <code>^test</code><br />
|-<br />
|[^x]<br />
|Отрицание символов<br />
|^[^m].*$<br />
|-<br />
| <code>$</code> || Конец строки || <code>test$</code><br />
|-<br />
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c<br />
|-<br />
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123<br />
|-<br />
| <code>.+</code> || Один или более || <code>test.+</code> → test-1<br />
|-<br />
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9<br />
|-<br />
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc<br />
|-<br />
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC<br />
|-<br />
| <code>(a&#124;b)</code> || "a" или "b" || <code>(test&#124;prod)</code><br />
|-<br />
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code><br />
|}<br />
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.<br />
<br />
Для правил отрицания конкретного элемента возможно использовать сложные правила, например:<br />
<br />
<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code><br />
<br />
Данное правило выбирает все ветки, кроме <code>main</code>.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3123Help:CLI/cleanup2025-10-13T16:25:41Z<p>Gribunin: cleanup info add more info and examples</p>
<hr />
<div>= Автоматическое удаление снимков =<br />
<br />
== Обзор ==<br />
<br />
Удаление происходит раз в час (данное время можно изменить в переменных окружения или при запуске сервера), первое удаление всех подходящих снимков будет через указанное время после запуска сервера.<br />
<br />
Применять может только пользователь с доступом '''ServerOperations'''.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление и заносится отметка в таблицу удаленных снимков.<br />
<br />
== Добавление нового правила удаления ==<br />
<br />
svacer server cleanup add-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --time <time> --max-snapshots <max><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> - проект, в котором искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--branch</code> - ветка, в которой искать снимки для удаления ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--snapshot</code> - снимок, который удалять ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--time</code> - время, которое должно пройти после создания '''(НЕ импорта)''' снимка, чтобы его удалить. Задается в формате Go Duration (например <code>33h5m</code>, <code>720h</code>). По умолчанию '''720 часов''' (30 дней). '''Игнорируется, если <code>--max-snapshots > 0</code>'''<br />
* <code>--max-snapshots</code> - верхняя граница по количеству снимков в ветке. При значении = 0 данное правило не работает. При значении > 0 '''игнорирует''' '''<code>--time</code>'''. По умолчанию 0<br />
<br />
=== Логика работы <code>--max-snapshots</code> ===<br />
<br />
'''MAX устанавливает верхнюю границу по количеству снимков в ветке:'''<br />
* Считает '''все''' снимки в ветке (total) если хотя бы один из снимков подходит под <code>project\branch\snapshot</code><br />
* Если <code>total > MAX</code>, удаляет <code>(total - MAX)</code> самых старых снимков<br />
* Удаляет '''только''' снимки, подходящие под паттерн <code>project\branch\snapshot</code><br />
* При <code>MAX = 0</code> данное правило не работает<br />
<br />
'''Примеры:'''<br />
<br />
Пример 1: Только TIME<br />
10 снимков в ветке, 5 старше 24h<br />
Правило: --time 24h --max-snapshots 0<br />
Результат: Удалит 5 старых снимков (>24h), останется 5<br />
<br />
Пример 2: Только MAX<br />
10 снимков в ветке<br />
Правило: --max-snapshots 5<br />
Результат: Удалит 5 самых старых, оставит 5 новейших<br />
<br />
Пример 3: MAX игнорирует TIME<br />
10 снимков, 5 старше 24h, 5 новых <24h<br />
Правило: --time 24h --max-snapshots 8<br />
Результат: <br />
TIME игнорируется. Применяется ТОЛЬКО MAX<br />
Удалит 2 самых старых и останется 8 (MAX)<br />
<br />
Пример 4: Scoped правило с MAX<br />
10 снимков: 6 nightly-*, 4 regular-*<br />
Правило: --snapshot "nightly-*" --max-snapshots 8<br />
Результат:<br />
total = 10 > MAX=8, нужно удалить 2<br />
Удалит 2 самых старых ТОЛЬКО из nightly-*<br />
Останется: 4 nightly-* + 4 regular-* = 8 снимков<br />
<br />
=== Шаблоны и паттерны ===<br />
<br />
Флаги <code>--project</code>, <code>--branch</code>, <code>--snapshot</code> можно задавать как:<br />
<br />
'''1. Имя или ID:'''<br />
--project "MyProject"<br />
--project "550e8400-e29b-41d4-a716-446655440000" # UUID проекта<br />
<br />
'''2. <code>*</code> (любое количество любых символов):'''<br />
--project "Dev*" # DevProject, Development<br />
--branch "*test*" # test, my-test, testing<br />
--snapshot "nightly-*"<br />
<br />
'''3. Регулярные выражения (с префиксом <code>re:</code>):'''<br />
--snapshot "re:^v[0-9]+\.[0-9]+\.[0-9]+$" # v1.0.0, v2.3.5<br />
--branch "re:^feature/[0-9]+$" # feature/123<br />
<br />
== Добавление запрета на удаление ==<br />
<br />
svacer server cleanup add-exclude-rule --user <user> --password <password> --project <project> --branch <branch> --snapshot <snapshot> --min-snapshots <min><br />
<br />
=== Параметры ===<br />
<br />
* <code>--project</code> - проект, в котором искать снимки для удаления ('''обязательный''' , используйте <code>"*"</code> для всех веток)<br />
<br />
* <code>--branch</code> - ветка ('''обязательный''', используйте <code>"*"</code> для всех веток)<br />
* <code>--snapshot</code> - снимок ('''обязательный''', используйте <code>"*"</code> для всех снимков)<br />
* <code>--min-snapshots</code> - нижняя граница по количеству снимков в ветке. По умолчанию '''0''' <br />
Флаги проекта, ветки и снимка работают аналогично с флагами в <code>--add-rule</code>.<br />
<br />
=== Логика работы <code>--min-snapshots</code> ===<br />
<br />
'''MIN устанавливает нижнюю границу по количеству снимков в ветке:'''<br />
<br />
'''Значение = 0''' — '''полный запрет на удаление:'''<br />
* Снимки, подходящие под паттерн <code>project\branch\snapshot</code>, '''никогда не удаляются'''<br />
* Применяется индивидуально к каждому снимку<br />
<br />
'''Значение > 0''' — '''минимальное количество в ветке:'''<br />
* Правило применяется ко '''всей ветке''', если хотя бы один снимок подходит под паттерн<br />
* Пока <code>total_snapshots ≤ MIN</code>, в ветке '''ничего не удаляется'''<br />
* После того как <code>total > MIN</code>, можно удалить до <code>(total - MIN)</code> снимков<br />
<br />
'''Важные моменты:'''<br />
* При множественных запретах для одной ветки берется '''МАКСИМАЛЬНОЕ''' значение MIN<br />
* MIN '''всегда''' имеет приоритет над MAX<br />
* Если MIN=5 и MAX=3, то в ветке останется 5 снимков (MIN побеждает)<br />
<br />
'''Примеры:'''<br />
<br />
Пример 1: MIN<br />
Правило: --min-snapshots 5<br />
Ветка имеет 10 снимков<br />
Результат: Можно удалить до 5 снимков (10 - 5 = 5)<br />
<br />
Пример 2: MIN с паттерном<br />
Правило: --snapshot "release-*" --min-snapshots 3<br />
Ветка имеет 8 снимков (включая 2 release-*)<br />
Результат: <br />
- Хотя бы 1 release-* есть → MIN=3 применяется ко ВСЕЙ ветке<br />
- Можно удалить до 5 снимков (8 - 3 = 5)<br />
<br />
Пример 3: MIN=0<br />
Правило: --snapshot "important-*" --min-snapshots 0<br />
Ветка имеет 10 снимков (2 important-*, 8 других)<br />
Результат:<br />
- important-* НИКОГДА не удаляются<br />
- Остальные 8 могут быть удалены<br />
<br />
Пример 4: Множественные MIN<br />
Правило 1: --snapshot "*" --min-snapshots 3<br />
Правило 2: --snapshot "release-*" --min-snapshots 5<br />
Ветка имеет 10 снимков (включая release-*)<br />
Результат: MIN = 5 (максимальное), можно удалить до 5 снимков<br />
<br />
== Удаление правила ==<br />
<br />
svacer server cleanup delete --user <user> --password <password> --id <config id><br />
<br />
Где:<br />
* <code>--id</code> — ID конфигурации из таблицы правил или запретов (получить через <code>cleanup list</code>)<br />
<br />
== Вывести таблицу ==<br />
<br />
svacer server cleanup list --user <user> --password <password> --type <rule|exclude-rule|log> --format <table|json><br />
<br />
Где:<br />
* <code>--type</code> — тип таблицы: <code>rule</code> — таблица правил удаления (по умолчанию); <code>exclude-rule</code> — таблица запретов на удаление; <code>log</code> — таблица удаленных снимков<br />
<br />
* <code>--format</code> — формат вывода: <code>table</code> — человекочитаемый вывод (по умолчанию); <code>json</code> — JSON формат<br />
== Запуск очистки вручную ==<br />
<br />
svacer server cleanup run --user <user> --password <password><br />
<br />
Запускает процесс очистки немедленно (вне расписания).<br />
<br />
== Примеры ==<br />
<br />
=== Добавление нового правила ===<br />
<br />
'''Правило 1: Удаление по времени (TIME mode)'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "*" --time "240h" --max-snapshots 0<br />
<br />
Удалятся снимки старше 240 часов (10 дней) в проектах, начинающихся с "Devel", в ветке "2025".<br />
<br />
'''Правило 2: Ограничение количества (MAX mode)'''<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --max-snapshots 20<br />
<br />
В любом проекте, в ветке "main" всегда будет максимум 20 снимков (независимо от возраста).<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "Devel*" --branch "2025" --snapshot "test*" --min-snapshots 0<br />
<br />
Снимки, начинающиеся с "test", в проектах "Devel*" и ветке "2025" '''никогда не удаляются'''.<br />
<br />
=== Вывод таблицы правил ===<br />
<br />
svacer server cleanup list --user admin --password admin --type rule<br />
<br />
[[File:Cleanup rules table.png|center|thumb|1006x1006px]]<br />
<br />
=== Вывод таблицы запретов ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule<br />
[[File:Cleanup exclude rule table.png|center|thumb|1009x1009px]]<br />
<br />
=== Вывод в JSON формате ===<br />
<br />
svacer server cleanup list --user admin --password admin --type exclude-rule --format json<br />
<br />
Вывод:<br />
<br />
[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","ID":"018fe552-f390-4110-9545-6ef9cbe1a406","MinBranchSnapshots":0,"Project":"Devel*","Snapshot":"test*","create_time":"2025-10-13T15:00:14.997004Z"}]<br />
<br />
=== Удаление правила ===<br />
<br />
svacer server cleanup delete --user admin --password admin --id b1895877-1f3c-4b12-ac19-3ff4a7bc5416<br />
<br />
=== Защита важных снимков ===<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "*" --branch "*" --snapshot "*release*" --min-snapshots 0<br />
<br />
Снимки <code>*release*</code> никогда не удаляются.<br />
<br />
=== Ограничение количества снимков ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --max-snapshots 20<br />
<br />
В ветке main хранить максимум 20 снимков.<br />
<br />
=== Комбинация MIN и MAX ===<br />
<br />
'''Минимум 5 снимков'''<br />
svacer server cleanup add-exclude-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --min-snapshots 5<br />
<br />
'''Максимум 20 снимков'''<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "main" --snapshot "*" --max-snapshots 20<br />
<br />
Результат: в ветке main всегда будет от 5 до 20 снимков.<br />
<br />
=== Использование regex ===<br />
<br />
svacer server cleanup add-rule --user admin --password admin --project "*" --branch "re:^feature/JIRA-[0-9]+$" --snapshot "*" --time 168h --max-snapshots 0<br />
<br />
Подходит: <code>feature/JIRA-123</code>, <code>feature/JIRA-456</code><br>Не подходит: <code>feature/JIRA-ABC</code>, <code>bugfix/JIRA-123</code><br />
<br />
=== Regex синтаксис ===<br />
<br />
{| class="wikitable"<br />
! Паттерн !! Описание !! Пример<br />
|-<br />
| <code>^</code> || Начало строки || <code>^test</code><br />
|-<br />
|[^x]<br />
|Отрицание символов<br />
|^[^m].*$<br />
|-<br />
| <code>$</code> || Конец строки || <code>test$</code><br />
|-<br />
| <code>.</code> || Любой символ || <code>a.c</code> → abc, a1c<br />
|-<br />
| <code>.*</code> || Любое кол-во символов || <code>test.*</code> → test-123<br />
|-<br />
| <code>.+</code> || Один или более || <code>test.+</code> → test-1<br />
|-<br />
| <code>[0-9]</code> || Любая цифра || <code>v[0-9]</code> → v1, v9<br />
|-<br />
| <code>[a-z]</code> || Буква (нижний регистр) || <code>[a-z]+</code> → abc<br />
|-<br />
| <code>[A-Z]</code> || Буква (верхний регистр) || <code>[A-Z]+</code> → ABC<br />
|-<br />
| <code>(a&#124;b)</code> || "a" или "b" || <code>(test&#124;prod)</code><br />
|-<br />
| <code>[0-9]{2,4}</code> || От 2 до 4 цифр || <code>12</code>, <code>1234</code><br />
|}<br />
Не поддерживается '''negative lookahead''' <code>(?!...)</code>. Используйте комбинацию правил и запретов.<br />
<br />
Для правил отрицания конкретного элемента возможно использовать сложные правила, например:<br />
<br />
<code>--branch "re:^(.{0,3}|.{5,}|[^m]...|m[^a]..|ma[^i].|mai[^n])$"</code><br />
<br />
Данное правило выбирает все ветки, кроме <code>main</code>.</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Cleanup_exclude_rule_table.png&diff=3122File:Cleanup exclude rule table.png2025-10-13T15:03:03Z<p>Gribunin: </p>
<hr />
<div>cleanup exclude rule table</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=File:Cleanup_rules_table.png&diff=3121File:Cleanup rules table.png2025-10-13T15:01:43Z<p>Gribunin: </p>
<hr />
<div>cleanup rules table</div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3069Help:CLI/cleanup2025-09-01T15:01:33Z<p>Gribunin: cleanup add max/min snapshots</p>
<hr />
<div>== Автоматическое удаление снимков ==<br />
Удаление происходит раз в час, первое удаление всех подходящих снимков будет через 1 час после запуска сервера.<br />
<br />
Применять может только пользователь с доступом ServerOperations.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление и заносится отметка в таблицу удаленных снимков.{{Note|text=Если снимок не задан в запрещенных к удалению, то он будет удаляться по минимальному времени, среди всех подходящих для него правил.}}<br />
<br />
=== Добавление нового правила удаления ===<br />
<br />
<code>svacer server cleanup add-rule --project <project id or name> --branch <branch id or name> --snapshot <snapshot id or name> --time <nowiki><time> max-snapshots <max snapshots in branch></nowiki></code><br />
<br />
Где:<br />
* project — проект в котором искать снимки для удаления<br />
* branch — ветка в которой искать снимки для удаления<br />
* snapshot — снимки которые удалять<br />
* time — время сколько должно пройти после создания снимка, чтобы его удалить, задается в формате Go Duration (например 33h5m). По умолчанию 720 часов (30 дней)<br />
* max-snapshots - верхняя граница по количеству снимков в ветке. Если снимков > max, удаляются самые старые, чтобы осталось ровно max (time не учитывается). Удаляются снимки, только подходящие под паттерн project\branch\snapshot, но количестве снимков считается во всей ветке (вне зависимости, подходит ли он под паттерн project\branch\snapshot или нет). При значении = 0 данное правило не работает. По умолчанию имеет значение 0. Данный флаг появился в версии 12-0-0.<br />
<br />
Флаги для проекта, ветки и снимка можно задавать как имя либо как ID, также в имени может быть знак *, который равен "любому количеству любых символов". Если данные флаги не заданы, то автоматически подставляется * (любой проект, ветка, снимок). <br />
<br />
С версии 12-0-0 в опциях <code>add-rule</code> и <code>add-prohibition</code> можно задавать регулярные выражения: для этого нужно в начале написать <code>re:</code> и следующая часть будет считаться регулярным выражением (в этом случае нужно будет указывать <code>.*</code> вместо <code>*</code>).<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
<code>svacer server cleanup add-prohibition --project <project id or name> --branch <branch id or name> --snapshot <snapshot id or name> min-snapshots <min snapshots in branch></code><br />
<br />
Где:<br />
<br />
* min-snapshots - нижняя граница по количеству снимков в ветке. Пока в ветке снимков ≤ min, в ветке ничего не удаляется правилами cleanup (данное правило применяется к ветке, если хотя бы один из снимков подошел под паттерн project\branch\snapshot). При значении = 0 данное правило не работает (и тогда устанавливается полный запрет на удаление снимков, подходящий под паттерн project\branch\snapshot). По умолчанию имеет значение 0. Данный флаг появился в версии 12-0-0.<br />
<br />
Остальные флаги работают аналогично с <code>svacer server cleanup add-rule</code><br />
<br />
=== Удаление правила ===<br />
<br />
<code>svacer server cleanup delete --id <config id></code><br />
<br />
Где:<br />
* id — id конфигурации из разрешенных к удалению или запрещенных к удалению<br />
<br />
=== Вывести таблицу ===<br />
<br />
<code>svacer server cleanup list --type <rule|prohibition|log> --format <table|json></code><br />
<br />
Где:<br />
* type — тип таблицы, которую нужно вывести <br />
:*rule — таблица удаляемых снимков<br />
:* prohibition — таблица запрещенных к удалению<br />
:* log — таблица удаленных снимков<br />
* format — формат вывода: table — таблица (человекочитаемый вывод), json<br />
<br />
=== Примеры ===<br />
<br />
'''Добавление нового правила'''<br />
<br />
<code>svacer server cleanup add-rule --user admin --password admin --project Devel* --branch 2025 --time "240h"</code><br />
<br />
<br />
'''Добавление запрета на удаление'''<br />
<br />
<code>svacer server cleanup add-prohibition --user admin --password admin --project Devel* --branch 2025 --snapshot test*</code><br />
<br />
<br />
'''Вывод данных таблиц'''<br />
<br />
<code>svacer server cleanup list --user admin --password admin --type prohibition</code><br />
<br />
[[File:Prohibition table.png|thumb|1017x1017px|none]]<br />
<br />
<br />
<code>svacer server cleanup list --user admin --password admin --type rule</code><br />
[[File:Rules table.png|thumb|1012x1012px|none]]<br />
<br />
<br />
<code>svacer server cleanup list --user admin --password admin --type prohibition --format json</code><br />
<br />
Вывод:<br />
<br />
<code>[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","DeleteTime":0,"ID":"7e2c2a12-3fd4-4bb2-8b3a-1f80d81c3bc5","Project":"Devel*","Snapshot":"test*","create_time":"2025-02-24T09:06:53.794742Z"}]</code><br />
<br />
<br />
'''Удаление элемента из таблицы'''<br />
<br />
<code>svacer server cleanup delete --user admin --password admin --id 878d1d1a-db1a-42a4-9557-ef568f68cd3e</code></div>Gribuninhttps://svacer.ispras.ru/mediawiki/index.php?title=Help:CLI/cleanup&diff=3052Help:CLI/cleanup2025-07-16T11:39:45Z<p>Gribunin: cleanup add info about regexp for add-rule</p>
<hr />
<div>== Автоматическое удаление снимков ==<br />
Удаление происходит раз в час, первое удаление всех подходящих снимков будет через 1 час после запуска сервера.<br />
<br />
Применять может только пользователь с доступом ServerOperations.<br />
<br />
'''Принцип работы:''' происходит проверка всех снимков на соответствие правилам удаления и правилам на запрет удаления, после этого происходит удаление и заносится отметка в таблицу удаленных снимков.{{Note|text=Если снимок не задан в запрещенных к удалению, то он будет удаляться по минимальному времени, среди всех подходящих для него правил.}}<br />
<br />
=== Добавление нового правила удаления ===<br />
<br />
<code>svacer server cleanup add-rule --project <project id or name> --branch <branch id or name> --snapshot <snapshot id or name> --time <nowiki><time></nowiki></code><br />
<br />
Где:<br />
* project — проект в котором искать снимки для удаления<br />
* branch — ветка в которой искать снимки для удаления<br />
* snapshot — снимки которые удалять<br />
* time — время сколько должно пройти после создания снимка, чтобы его удалить, задается в формате Go Duration (например 33h5m). По умолчанию 720 часов (30 дней)<br />
<br />
Флаги для проекта, ветки и снимка можно задавать как имя либо как ID, также в имени может быть знак *, который равен "любому количеству любых символов". Если данные флаги не заданы, то автоматически подставляется * (любой проект, ветка, снимок). С версии 12-0-0 в опциях <code>add-rule</code> и <code>add-prohibition</code> можно задавать регулярные выражения, тогда нужно в начале написать "re:" и следующая часть будет считаться регулярным выражением (и тогда нужно будет указывать ".*" вместо "*").<br />
<br />
=== Добавление запрета на удаление ===<br />
<br />
<code>svacer server cleanup add-prohibition --project <project id or name> --branch <branch id or name> --snapshot <snapshot id or name></code><br />
<br />
Флаги работают аналогично с <code>svacer server cleanup add-rule</code><br />
<br />
=== Удаление правила ===<br />
<br />
<code>svacer server cleanup delete --id <config id></code><br />
<br />
Где:<br />
* id — id конфигурации из разрешенных к удалению или запрещенных к удалению<br />
<br />
=== Вывести таблицу ===<br />
<br />
<code>svacer server cleanup list --type <rule|prohibition|log> --format <table|json></code><br />
<br />
Где:<br />
* type — тип таблицы, которую нужно вывести <br />
:*rule — таблица удаляемых снимков<br />
:* prohibition — таблица запрещенных к удалению<br />
:* log — таблица удаленных снимков<br />
* format — формат вывода: table — таблица (человекочитаемый вывод), json<br />
<br />
=== Примеры ===<br />
<br />
'''Добавление нового правила'''<br />
<br />
<code>svacer server cleanup add-rule --user admin --password admin --project Devel* --branch 2025 --time "240h"</code><br />
<br />
<br />
'''Добавление запрета на удаление'''<br />
<br />
<code>svacer server cleanup add-prohibition --user admin --password admin --project Devel* --branch 2025 --snapshot test*</code><br />
<br />
<br />
'''Вывод данных таблиц'''<br />
<br />
<code>svacer server cleanup list --user admin --password admin --type prohibition</code><br />
<br />
[[File:Prohibition table.png|thumb|1017x1017px|none]]<br />
<br />
<br />
<code>svacer server cleanup list --user admin --password admin --type rule</code><br />
[[File:Rules table.png|thumb|1012x1012px|none]]<br />
<br />
<br />
<code>svacer server cleanup list --user admin --password admin --type prohibition --format json</code><br />
<br />
Вывод:<br />
<br />
<code>[{"Branch":"2025","CreatedBy":"admin","CreatedById":"00000000-0000-0000-0000-000000000000","DeleteTime":0,"ID":"7e2c2a12-3fd4-4bb2-8b3a-1f80d81c3bc5","Project":"Devel*","Snapshot":"test*","create_time":"2025-02-24T09:06:53.794742Z"}]</code><br />
<br />
<br />
'''Удаление элемента из таблицы'''<br />
<br />
<code>svacer server cleanup delete --user admin --password admin --id 878d1d1a-db1a-42a4-9557-ef568f68cd3e</code></div>Gribunin