Pipelines - Revision history

Akuzmin: fix page link (installation > configuration)

2025-12-03T10:19:36Z

fix page link (installation > configuration)

← Older revision		Revision as of 13:19, 3 December 2025
Line 61:		Line 61:
	{{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\|пример конфига]]}}

Akuzmin: add note about 'underscores_in_headers'

2025-07-07T14:45:14Z

add note about 'underscores_in_headers'

← Older revision		Revision as of 17:45, 7 July 2025
Line 59:		Line 59:
	[[File:Pipeline-warning.png\|frame\|none]]		[[File:Pipeline-warning.png\|frame\|none]]

	{{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:34:52Z

add note about 'underscores_in_headers'

← Older revision		Revision as of 17:34, 7 July 2025
Line 58:		Line 58:

	[[File:Pipeline-warning.png\|frame\|none]]		[[File:Pipeline-warning.png\|frame\|none]]

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

Akuzmin at 11:48, 17 June 2025

2025-06-17T11:48:51Z

← Older revision		Revision as of 14:48, 17 June 2025
Line 52:		Line 52:
	* Запускается анализ (svace analyze)		* Запускается анализ (svace analyze)
	* После фазы анализа запускается импорт данных анализа в Svacer (svacer import). На этом этапе указывается имя проекта, ветки и снимка, которые будут отображаться в интерфейсе Svacer-сервера после загрузки. Имена берутся из CI-переменных гитлаба, к имени снимка добавляется текущая дата		* После фазы анализа запускается импорт данных анализа в Svacer (svacer import). На этом этапе указывается имя проекта, ветки и снимка, которые будут отображаться в интерфейсе Svacer-сервера после загрузки. Имена берутся из CI-переменных гитлаба, к имени снимка добавляется текущая дата
	* На этапе загрузки (svacer upload) добавляются две опции: '''quality-gate''' и '''quality-gate-exit-code''' ([[Help:Import_from_Svace#Использование_quality_gate\|документация по quality-gate]])		* На этапе загрузки (svacer upload) добавляются две опции: '''quality-gate''' и '''quality-gate-exit-code''' ([[Help:Import_from_Svace#Использование_quality_gate\|документация по quality gate]])
	:* <code>--quality-gate total:critical:0</code> — quality gate сработает, если статическим анализатором будут найдены предупреждения с severity:critical		:* <code>--quality-gate total:critical:0</code> — quality gate сработает, если статическим анализатором будут найдены предупреждения с severity:critical
	:* <code>--quality-gate-exit-code 1</code> — в случае срабатывания quality gate команда вернет exit code 1		:* <code>--quality-gate-exit-code 1</code> — в случае срабатывания quality gate команда вернет exit code 1

Akuzmin: remove quality-gate help text, add link instead

2025-06-17T11:48:15Z

remove quality-gate help text, add link instead

← Older revision		Revision as of 14:48, 17 June 2025
Line 52:		Line 52:
	* Запускается анализ (svace analyze)		* Запускается анализ (svace analyze)
	* После фазы анализа запускается импорт данных анализа в Svacer (svacer import). На этом этапе указывается имя проекта, ветки и снимка, которые будут отображаться в интерфейсе Svacer-сервера после загрузки. Имена берутся из CI-переменных гитлаба, к имени снимка добавляется текущая дата		* После фазы анализа запускается импорт данных анализа в Svacer (svacer import). На этом этапе указывается имя проекта, ветки и снимка, которые будут отображаться в интерфейсе Svacer-сервера после загрузки. Имена берутся из CI-переменных гитлаба, к имени снимка добавляется текущая дата
	* На этапе загрузки (svacer upload) добавляются две опции: '''quality-gate''' и '''quality-gate-exit-code'''		* На этапе загрузки (svacer upload) добавляются две опции: '''quality-gate''' и '''quality-gate-exit-code''' ([[Help:Import_from_Svace#Использование_quality_gate\|документация по quality-gate]])
	:* <code>--quality-gate total:critical:0</code> — quality gate сработает, если статическим анализатором будут найдены предупреждения с severity:critical		:* <code>--quality-gate total:critical:0</code> — quality gate сработает, если статическим анализатором будут найдены предупреждения с severity:critical
	:* <code>--quality-gate-exit-code 1</code> — в случае срабатывания quality gate команда вернет exit code 1		:* <code>--quality-gate-exit-code 1</code> — в случае срабатывания quality gate команда вернет exit code 1
Line 58:		Line 58:

	[[File:Pipeline-warning.png\|frame\|none]]		[[File:Pipeline-warning.png\|frame\|none]]

	~~Подробнее об использовании quality-gate смотрите в <code>svacer upload --help</code>:~~

	~~<pre>~~
	--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.
	~~--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-verbose Specify this flag to obtain additional information about the evaluation results of quality gate. (default: false)~~
	~~</pre>~~

Gribunin: quality gate change help cli

2025-06-16T12:25:23Z

quality gate change help cli

← Older revision		Revision as of 15:25, 16 June 2025
Line 62:		Line 62:

	<pre>		<pre>
	--quality-gate value Specify a quality gate. Format: stat_1:severity_1:N_1,...,stat_k:severity_k:N_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. 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.		--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.
	--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.
	--quality-gate-verbose Specify this flag to obtain additional information about the evaluation results of quality gate. (default: false)		--quality-gate-verbose Specify this flag to obtain additional information about the evaluation results of quality gate. (default: false)
	</pre>		</pre>

Akuzmin: Akuzmin moved page Примеры пайплайнов to Pipelines: Misspelled title: rename

2025-05-19T11:28:48Z

Akuzmin moved page Примеры пайплайнов to Pipelines: Misspelled title: rename

← Older revision	Revision as of 14:28, 19 May 2025
(No difference)

Akuzmin: add note about 9.0.0 bug in quality-gate

2025-01-17T13:42:25Z

add note about 9.0.0 bug in quality-gate

← Older revision		Revision as of 16:42, 17 January 2025
Line 17:		Line 17:

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

			{{Note\|text=В версии 9.х.х был баг в quality-gate: он всегда возвращал 0, даже если задан другой exit code. В версии 10.0.0 это исправили.}}

	В этом примере пайплайна из Gitlab-CI после этапов сборки и анализа запускается импорт результатов с указанием имен проекта, ветки и снимка, взятых из CI-переменных, а при загрузке используется quality-gate, который меняет статус пайплайна в зависимости от результатов статического анализа.		В этом примере пайплайна из Gitlab-CI после этапов сборки и анализа запускается импорт результатов с указанием имен проекта, ветки и снимка, взятых из CI-переменных, а при загрузке используется quality-gate, который меняет статус пайплайна в зависимости от результатов статического анализа.

Akuzmin: add basic pipeline example

2024-11-14T14:50:58Z

add basic pipeline example

@@ Line 1: / Line 1: @@
 === Использование quality gate ===
-В этом примере пайплайна из Gitlab-CI запускается сборка и анализ в докер-контейнере, где уже установлен Svace, Svacer и базовые пакеты для сборки (метапакет build-essential).
+В этом примере пайплайна из Gitlab-CI после этапов сборки и анализа запускается импорт результатов с указанием имен проекта, ветки и снимка, взятых из CI-переменных, а при загрузке используется quality-gate, который меняет статус пайплайна в зависимости от результатов статического анализа.
 <pre>
@@ Line 19: / Line 36: @@
      - /opt/svace/bin/svace build --init make -j`nproc`
      - /opt/svace/bin/svace analyze
-     - /usr/bin/svacer import --svace /opt/svace/bin/svace --project "${CI_PROJECT_NAMESPACE}-${CI_PROJECT_NAME}" --branch $CI_COMMIT_REF_NAME --snapshot "$CI_COMMIT_SHORT_SHA - `date -R`" .
+     - /usr/bin/svacer import --svace /opt/svace/bin/svace --project "${CI_PROJECT_NAMESPACE}-${CI_PROJECT_NAME}" --branch $CI_COMMIT_REF_NAME --snapshot "$CI_COMMIT_SHORT_SHA - `date -R`"
      - /usr/bin/svacer upload --host https://svacer.ispras.ru --quick-stats --quality-gate total:critical:0 --quality-gate-exit-code 1

Akuzmin: create page and quality-gate example

2024-11-13T15:16:42Z

create page and quality-gate example

New page

=== Использование quality gate ===
В этом примере пайплайна из Gitlab-CI запускается сборка и анализ в докер-контейнере, где уже установлен Svace, Svacer и базовые пакеты для сборки (метапакет build-essential).

<pre>
image: registry.ispras.ru/demo/docker-images/ubuntu-svace-svacer:focal-3.4.240902-9.0.2

analyze:
stage: build

tags:
- docker
- linux

script:
- apt update
- apt install -y git python3 pkg-config mesa-common-dev libgl-dev libglu1-mesa-dev freeglut3-dev libx11-dev libxi-dev libxrandr-dev
- git clone --recurse-submodules -j`nproc` https://github.com/ArtifexSoftware/mupdf.git
- cd mupdf
- /opt/svace/bin/svace build --init make -j`nproc`
- /opt/svace/bin/svace analyze
- /usr/bin/svacer import --svace /opt/svace/bin/svace --project "${CI_PROJECT_NAMESPACE}-${CI_PROJECT_NAME}" --branch $CI_COMMIT_REF_NAME --snapshot "$CI_COMMIT_SHORT_SHA - `date -R`" .
- /usr/bin/svacer upload --host https://svacer.ispras.ru --quick-stats --quality-gate total:critical:0 --quality-gate-exit-code 1

allow_failure:
exit_codes:
- 1
</pre>

* В начале ставятся специфические зависимости, необходимые для сборки mupdf
* Клонируется репозиторий с его сабмодулями
* Запускается сборка с перехватом ее статическим анализатором (svace build)
* Запускается анализ (svace analyze)
* После фазы анализа запускается импорт данных анализа в Svacer (svacer import). На этом этапе указывается имя проекта, ветки и снимка, которые будут отображаться в интерфейсе Svacer-сервера после загрузки. Имена берутся из CI-переменных гитлаба, к имени снимка добавляется текущая дата
* На этапе загрузки (svacer upload) добавляются две опции: '''quality-gate''' и '''quality-gate-exit-code'''
:* <code>--quality-gate total:critical:0</code> — quality gate сработает, если статическим анализатором будут найдены предупреждения с severity:critical
:* <code>--quality-gate-exit-code 1</code> — в случае срабатывания quality gate команда вернет exit code 1
* Далее в пайплайне указываем, что exit code 1 считается как допустимый failure. Гитлаб в этом случае отобразит статус пайплайна '''Warning'''. Если quality gate не сработает (предупреждений с severity:critical не будет найдено), пайплайн завершитcя со статусом '''Passed'''

[[File:Pipeline-warning.png|frame|none]]

Подробнее об использовании quality-gate смотрите в <code>svacer upload --help</code>:

<pre>
--quality-gate value Specify a quality gate. Format: stat_1:severity_1:N_1,...,stat_k:severity_k:N_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. 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.
--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-verbose Specify this flag to obtain additional information about the evaluation results of quality gate. (default: false)
</pre>