Help:Import from Svace - Revision history

Akuzmin: /* Флаг --baseline-check */ minor fixes

2026-02-10T11:48:09Z

Флаг --baseline-check: minor fixes

← Older revision		Revision as of 14:48, 10 February 2026
Line 348:		Line 348:
	Данный флаг принимает следующие параметры:		Данный флаг принимает следующие параметры:

	* пустой или 'project,branch,snapshot~~' (~~требует проект, ветку и снимок, по умолчанию)		* пустой или <code>project,branch,snapshot</code> — требует проект, ветку и снимок, по умолчанию
	* 'skip~~' (~~разрешает отсутствие проекта, ветки, снимка)		* <code>skip</code> — разрешает отсутствие проекта, ветки, снимка
	* 'project~~' (~~требует проект, разрешает отсутствие ветки и снимка)		* <code>project</code> — требует проект, разрешает отсутствие ветки и снимка
	* 'project,branch~~' (~~требует проект и ветку, разрешает отсутствие снимка)		* <code>project,branch</code> — требует проект и ветку, разрешает отсутствие снимка

	Можно использовать полные названия с запятыми или сокращения без запятых: 'p' для project, 'b' для branch, 's' для snapshot, например 'pbs'. Всегда пытается найти снимок; если он не найден, то использует пустой baseline (и все предупреждения помечаются как New). Ошибка возвращается только если не выполнен обязательный уровень.		Можно использовать полные названия с запятыми или сокращения без запятых: <code>p</code> для project, <code>b</code> для branch, <code>s</code> для snapshot, например <code>pbs</code>. Всегда пытается найти снимок; если он не найден, то использует пустой baseline и все предупреждения помечаются как New. Ошибка возвращается только если не выполнен обязательный уровень.

	==== Флаг --out-file ====		==== Флаг --out-file ====

Gribunin: baseline-check

2026-01-30T14:53:52Z

baseline-check

← Older revision		Revision as of 17:53, 30 January 2026
Line 342:		Line 342:

	Если baseline не может быть точно определен (ошибка в имени проекта, ветки и т. п.), то импорт не производится и выдается ошибка.		Если baseline не может быть точно определен (ошибка в имени проекта, ветки и т. п.), то импорт не производится и выдается ошибка.

			==== Флаг --baseline-check ====
			Для вывода quick-stats и quality-gate даже в случае отсутствия снимка, ветки или проекта используйте опцию <code>--baseline-check</code>.

			Данный флаг принимает следующие параметры:

			* пустой или 'project,branch,snapshot' (требует проект, ветку и снимок, по умолчанию)
			* 'skip' (разрешает отсутствие проекта, ветки, снимка)
			* 'project' (требует проект, разрешает отсутствие ветки и снимка)
			* 'project,branch' (требует проект и ветку, разрешает отсутствие снимка)

			Можно использовать полные названия с запятыми или сокращения без запятых: 'p' для project, 'b' для branch, 's' для snapshot, например 'pbs'. Всегда пытается найти снимок; если он не найден, то использует пустой baseline (и все предупреждения помечаются как New). Ошибка возвращается только если не выполнен обязательный уровень.

	==== Флаг --out-file ====		==== Флаг --out-file ====

Akuzmin: fix page link (installation > configuration)

2025-12-03T10:37:17Z

fix page link (installation > configuration)

← Older revision		Revision as of 13:37, 3 December 2025
Line 146:		Line 146:
	{{Note\|text=Для корректной работы опций <code>--quality-gate</code> и <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:		{{Note\|text=Для корректной работы опций <code>--quality-gate</code> и <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:
	underscores_in_headers on;		underscores_in_headers on;
	См. [[Help:~~Installation~~#Nginx\|пример конфига]]}}		См. [[Help:Configuration#Nginx\|пример конфига]]}}

	svacer upload ... --quick-stats --out-format text ...		svacer upload ... --quick-stats --out-format text ...
Line 300:		Line 300:
	{{Note\|text=Для корректной работы опций <code>--quality-gate</code> и <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:		{{Note\|text=Для корректной работы опций <code>--quality-gate</code> и <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:
	underscores_in_headers on;		underscores_in_headers on;
	См. [[Help:~~Installation~~#Nginx\|пример конфига]]}}		См. [[Help:Configuration#Nginx\|пример конфига]]}}

	==== Флаг --quality-gate-exit-code ====		==== Флаг --quality-gate-exit-code ====

Akuzmin: add note about 'underscores_in_headers'

2025-07-07T14:46:57Z

add note about 'underscores_in_headers'

← Older revision		Revision as of 17:46, 7 July 2025
Line 297:		Line 297:
	- "total:all:1"		- "total:all:1"
	- "total:proc:1"		- "total:proc:1"

			{{Note\|text=Для корректной работы опций <code>--quality-gate</code> и <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:
			underscores_in_headers on;
			См. [[Help:Installation#Nginx\|пример конфига]]}}

	==== Флаг --quality-gate-exit-code ====		==== Флаг --quality-gate-exit-code ====

Akuzmin: add note about 'underscores_in_headers'

2025-07-07T14:46:02Z

add note about 'underscores_in_headers'

← Older revision		Revision as of 17:46, 7 July 2025
Line 144:		Line 144:
	При загрузке данных на сервер можно включить печать краткой статистики по загруженным результатам. Данная статистика включает информацию о новых и пропущенных предупреждениях, по сравнению с последним ранее загруженным снимком. Выдача краткой статистики возможно в текстовом или JSON виде. Результаты печатаются в stdout.		При загрузке данных на сервер можно включить печать краткой статистики по загруженным результатам. Данная статистика включает информацию о новых и пропущенных предупреждениях, по сравнению с последним ранее загруженным снимком. Выдача краткой статистики возможно в текстовом или JSON виде. Результаты печатаются в stdout.

	{{Note\|text=Для корректной работы ~~опции~~ <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:		{{Note\|text=Для корректной работы опций <code>--quality-gate</code> и <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:
	underscores_in_headers on;		underscores_in_headers on;
	См. [[Help:Installation#Nginx\|пример конфига]]}}		См. [[Help:Installation#Nginx\|пример конфига]]}}

Akuzmin: add note about 'underscores_in_headers'

2025-07-07T14:33:14Z

add note about 'underscores_in_headers'

← Older revision		Revision as of 17:33, 7 July 2025
Line 124:		Line 124:
	Для загрузки данных из промежуточного хранилища на сервер используется команда '''upload''':		Для загрузки данных из промежуточного хранилища на сервер используется команда '''upload''':

	svacer upload --user <user> --password <pwd> --host <host> --port <rest_port> --grpc <grpc_port> <path_to_store>		svacer upload --user <user> --password <pwd> --host <host> --port <rest_port> --grpc <grpc_port> <path_to_store>

	Если отсутствуют параметры:		Если отсутствуют параметры:
Line 135:		Line 135:
	В случае если Svacer запущен с поддержкой SSL/TLS или работает за reverse proxy и доступен по протоколу HTTPS, то для загрузки требуется явно указать протокол в параметре '''--host''', либо добавить опцию '''--ssl'''.		В случае если Svacer запущен с поддержкой SSL/TLS или работает за reverse proxy и доступен по протоколу HTTPS, то для загрузки требуется явно указать протокол в параметре '''--host''', либо добавить опцию '''--ssl'''.

	svacer upload --host https://<url_without_port> <path_to_store>		svacer upload --host https://<url_without_port> <path_to_store>
	svacer upload --ssl --host <url_without_port> <path_to_store>		svacer upload --ssl --host <url_without_port> <path_to_store>

	При этом grpc порт (по умолчанию — 3002), по которому идет загрузка данных, на сервере должен быть доступен.		При этом grpc порт (по умолчанию — 3002), по которому идет загрузка данных, на сервере должен быть доступен.
Line 144:		Line 144:
	При загрузке данных на сервер можно включить печать краткой статистики по загруженным результатам. Данная статистика включает информацию о новых и пропущенных предупреждениях, по сравнению с последним ранее загруженным снимком. Выдача краткой статистики возможно в текстовом или JSON виде. Результаты печатаются в stdout.		При загрузке данных на сервер можно включить печать краткой статистики по загруженным результатам. Данная статистика включает информацию о новых и пропущенных предупреждениях, по сравнению с последним ранее загруженным снимком. Выдача краткой статистики возможно в текстовом или JSON виде. Результаты печатаются в stdout.

	svacer upload ... --quick-stats --out-format text ...		{{Note\|text=Для корректной работы опции <code>--quick-stats</code> при использовании reverse proxy, в частности Nginx, для gRPC порта Svacer, необходимо в настройках секции http или server добавить инструкцию:
			underscores_in_headers on;
			См. [[Help:Installation#Nginx\|пример конфига]]}}

			svacer upload ... --quick-stats --out-format text ...

	Пример вывода		Пример вывода
	Quick Stats:		Quick Stats:
	Previous snapshot : Snapshot 2022-11-16 10:11:37 +0300		Previous snapshot : Snapshot 2022-11-16 10:11:37 +0300
	Current snapshot : Snapshot 2022-11-16 10:23:08 +0300		Current snapshot : Snapshot 2022-11-16 10:23:08 +0300
	New : 1		New : 1
	Missing : 0		Missing : 0
	Matched : 1		Matched : 1
	Same : 0		Same : 0

	svacer upload ... --quick-stats --out-format json ...		svacer upload ... --quick-stats --out-format json ...

	Пример вывода		Пример вывода
	{"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}		{"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}

	Формат JSON определяется protobuf3 схемой (ряд полей носит внутренний характер):		Формат JSON определяется protobuf3 схемой (ряд полей носит внутренний характер):

Gribunin: /* Использование quality gate */

2025-07-07T11:59:55Z

Использование quality gate

← Older revision		Revision as of 14:59, 7 July 2025
Line 258:		Line 258:
	** '''matched''' — присутствуют изменения в файлах, не повлиявшие на выданное предупреждение		** '''matched''' — присутствуют изменения в файлах, не повлиявшие на выданное предупреждение
	** '''same''' — одинаковые		** '''same''' — одинаковые
	** '''total''' — сумма всех вышеперечисленных		** '''total''' — сумма всех вышеперечисленных (то есть количество предупреждений в объединении старого и нового снимков)
	* severity задается либо непосредственным его указанием ('''critical''', '''major''', '''normal''', '''minor''', '''undefined'''), либо '''all''' (все severity), либо частью имени детектора в формате [https://www.postgresql.org/docs/current/functions-matching.html postgres ILIKE]		* severity задается либо непосредственным его указанием ('''critical''', '''major''', '''normal''', '''minor''', '''undefined'''), либо '''all''' (все severity), либо частью имени детектора в формате [https://www.postgresql.org/docs/current/functions-matching.html postgres ILIKE]
	* N — порог, после которого вызывается срабатывание. Не включает данное число (т. е. если указать 5, то при нахождении 6 и более вызывается срабатывание quality-gate)		* N — порог, после которого вызывается срабатывание. Не включает данное число (т. е. если указать 5, то при нахождении 6 и более вызывается срабатывание quality-gate)

Akuzmin: review and minor fixes

2025-06-17T13:27:57Z

review and minor fixes

Show changes

Ruseer: /* Использование quality gate */

2025-06-17T05:34:07Z

Использование quality gate

Ruseer: /* Загрузка данных на сервер */ (update protobuf scheme)

2025-06-17T05:27:36Z

Загрузка данных на сервер: (update protobuf scheme)

← Older revision		Revision as of 08:27, 17 June 2025
Line 160:		Line 160:
	{"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}		{"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}

	Формат JSON определяется protobuf3 схемой:		Формат JSON определяется protobuf3 схемой (ряд полей носит внутренний характер):
	message ImportSummaryContext {		message ImportSummaryContext {
	string branch = 1;		string branch = 1;
	string snapshot = 2;		string snapshot = 2;
	string snapshotName = 9;		string snapshotName = 9;
	string lastSnapshot = 3;		string lastSnapshot = 3;
	string lastSnapshotName = 4;		string lastSnapshotName = 4;
	int64 new = 5;		int64 new = 5;
	int64 missing = 6;		int64 missing = 6;
	int64 matched = 7;		int64 matched = 7;
	int64 same = 8;		int64 same = 8;
	}		string qualityGate = 10;
			string baseline_branch_name = 11;
			string baseline_project_name = 12;
			string branch_name = 13;
			string project_name = 14;
			string project_id = 15;
			string baseline_snapshot_id = 16;
			string baseline_branch_id = 19;
			string baseline_project_id = 20;
			string baseline_snapshot_name = 21;
			}

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

← Older revision		Revision as of 08:34, 17 June 2025
Line 261:		Line 261:
	* severity задается либо непосредственным его указанием ('''critical''', '''major''', '''normal''', '''minor''', '''undefined'''), либо '''all''' (все severity), либо частью имени детектора в формате postgres ILIKE https://www.postgresql.org/docs/current/functions-matching.html		* severity задается либо непосредственным его указанием ('''critical''', '''major''', '''normal''', '''minor''', '''undefined'''), либо '''all''' (все severity), либо частью имени детектора в формате postgres ILIKE https://www.postgresql.org/docs/current/functions-matching.html
	* N - порог, после которого вызывается срабатывание. Не включает данное число (т.е. если указать 5, то при нахождении 6 и более вызывается срабатывание quality-gate)		* N - порог, после которого вызывается срабатывание. Не включает данное число (т.е. если указать 5, то при нахождении 6 и более вызывается срабатывание quality-gate)
	* statuses - '''опциональное''' поле, в котором можно указать какие статусы (разметку) учитывать при нахождении предупреждений. Возможные значения '''confirmed''', '''false_positive''', '''wont_fix''', '''unclear''', '''undecided'''. Задаются в квадратных скобках с разделителем ";". Например, [confirmed;wont_fix]. Если не указать данное поле, то будут учитываться все статусы. Принципы учета статусов:		* statuses - '''опциональное''' поле, в котором можно указать какие статусы (разметку) учитывать при нахождении предупреждений. Возможные значения '''confirmed''', '''false_positive''', '''wont_fix''', '''unclear''', '''undecided'''. Задаются в квадратных скобках с разделителем ";". Например, [confirmed;wont_fix]. Если не указать данное поле, то будут учитываться все статусы. При указании в command line рекомендуется значение опции <code>--quality-gate</code> экранировать в двойные кавычки. Принципы учета статусов:
	** Если предупреждение размечено в новом снимке (значение не '''undecided'''), разметка берется из нового предупреждения		** Если предупреждение размечено в новом снимке (значение не '''undecided'''), разметка берется из нового предупреждения
	** Если в новом снимке нет разметки у данного предупреждения, а в старом есть, то берется разметка из старого предупреждения		** Если в новом снимке нет разметки у данного предупреждения, а в старом есть, то берется разметка из старого предупреждения
Line 296:		Line 296:
	В случае срабатывания quality gate можно указать какой exit code будет возвращен		В случае срабатывания quality gate можно указать какой exit code будет возвращен
	--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.		--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.
	Принимает значения от 0 до 125 (по умолчанию 0)		Принимает значения от 0 до 125. '''Внимание''': значение по умолчанию 0, поэтому без явного задания exit code провал quality-gate-а не вернет не нулевой статус и при использовании в CI/CD pipline не будет помечен как failed. Так сделано для упрощения внедрения quality-gate опции в существующие pipeline-ы. Вначале можно проанализировать логи и если данные корректны, то добавить опцию <code>--quality-gate-exit-code</code> с не нулевым значением.

	==== Флаг --quality-gate-verbose ====		==== Флаг --quality-gate-verbose ====
Line 319:		Line 319:

	==== Флаг --baseline ====		==== Флаг --baseline ====
	Если сравнение необходимо проводить не с предыдущим снимком в этой же ветке, то можно указать флаг '''--baseline''' (также работает для флага --quick-stats)		Если сравнение необходимо проводить не с предыдущим снимком в этой же ветке, то можно указать флаг '''--baseline''' (также работает для флага <code>--quick-stats</code>)
	--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.		--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.
	Указывается в формате {project}:::{branch}:::{snapshot} или {project}:::{branch} или {project}, используя имена или UUID. По умолчанию используется ветка master (если указан только проект) и последний добавленный снимок (если снимок не указан).		Указывается в формате <code>{project}:::{branch}:::{snapshot}</code> или <code>{project}:::{branch}</code> или <code>{project}</code>, используя имена или UUID. По умолчанию используется ветка master (если указан только проект) и последний добавленный снимок (если снимок не указан).

	При указании данного флага меняется вывод:		При указании данного флага меняется вывод:
Line 327:		Line 327:
	* В текстовом формате добавляются строки об имени проекта, ветки и снимка, с которым сравнивался загружаемый снимок.		* В текстовом формате добавляются строки об имени проекта, ветки и снимка, с которым сравнивался загружаемый снимок.
	* В json формате добавляются имена и id проекта,ветки и снимка, с которым сравнивался загружаемый снимок.		* В json формате добавляются имена и id проекта,ветки и снимка, с которым сравнивался загружаемый снимок.
			* '''Внимание''': если baseline не может быть точно определен (ошибка в имени проекта, ветки и т.п), то импорт не производится и выдается ошибка.

	'''Флаг --out-file'''		'''Флаг --out-file'''