Работа с критериями качества (QualityGate)
Получение списка Quality Gate
Для того чтобы получить список существующих Quality Gates, выполните команду
vampy-cli list sqg
--------
Getting list or quality gates...
--------
Quality Gates (5 of 5):
┌──────────┬───────────────────────────────┬─────────────┬────────────────────────────────────────────────────────────────────────────────────────────┐
│ NAME │ SLUG │ CRITICALITY │ LINK │
├──────────┼───────────────────────────────┼─────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
│ None │ default-quality-gate-none │ │ https://vampy.corp.hexway.io/quality?qualityGateId=4ef9790e-f1ff-47af-947e-23422f72b7a4 │
│ Low │ default-quality-gate-low │ LOW │ https://vampy.corp.hexway.io/quality?qualityGateId=f0b06eb7-efb4-46f2-9dd5-581199bed9c6 │
│ Medium │ default-quality-gate-medium │ MEDIUM │ https://vampy.corp.hexway.io/quality?qualityGateId=806097c4-dded-4afe-857a-b25003cb4f2b │
│ High │ default-quality-gate-high │ HIGH │ https://vampy.corp.hexway.io/quality?qualityGateId=97da0b79-1098-4af2-852e-70d6fc86542e │
│ Critical │ default-quality-gate-critical │ CRITICAL │ https://vampy.corp.hexway.io/quality?qualityGateId=d74e08c9-8631-42cc-86f8-2dca5aae59f0 │
└──────────┴───────────────────────────────┴─────────────┴────────────────────────────────────────────────────────────────────────────────────────────┘
Для работы с SQG используйте параметр sqg
Проверка на соответствие Quality Gate
Вы можете проверять соответствие продукта/репозитория (--product/--repository) заданным парметрам QG
В результате выполнения команды вы не только полчите информацию о неуспешности/успешности прохождения, но так же и статус код, который может быть использован для принятия решения о необходимости останавливать пайплайн
Параметры команды sqg (quality-gate)
| Параметр | Описание | Значение по умолчанию |
|---|---|---|
--repository value |
SLUG или ID репозитория | |
--branch value |
Ветка репозитория | |
--product value |
SLUG или ID продукта |
vampy-cli sqg --repository vmp/product/vampy-engine --details
--------
Checking SQG for repository 'vmp/product/vampy-engine' ...
--------
⛔ QualityGate: 'Critical'
Repository: 'Vampy Engine'
Link: https://vampy.corp.hexway.io/repositories/1efd4494-738c-404b-aa1b-14a8959de52d/
Status: FAILED
Results:
┌────────┬──────────────┬────────────┬───────────┬───────────────┐
│ STATUS │ SCANNER TYPE │ SEVERITIES │ MAX VALUE │ CURRENT VALUE │
├────────┼──────────────┼────────────┼───────────┼───────────────┤
│ PASSED │ SAST │ CRITICAL │ 0 │ 0 │
│ PASSED │ DAST │ CRITICAL │ 0 │ 0 │
│ FAILED │ SCA │ CRITICAL │ 0 │ 1 │
│ PASSED │ SAST │ HIGH │ 0 │ 0 │
│ PASSED │ DAST │ HIGH │ 0 │ 0 │
│ FAILED │ SCA │ HIGH │ 10 │ 20 │
│ PASSED │ SAST │ MEDIUM │ 5 │ 0 │
│ PASSED │ DAST │ MEDIUM │ 5 │ 0 │
│ FAILED │ SCA │ MEDIUM │ 40 │ 62 │
│ PASSED │ SAST │ LOW │ 10 │ 0 │
│ PASSED │ DAST │ LOW │ 10 │ 0 │
│ FAILED │ SCA │ LOW │ 100 │ 137 │
└────────┴──────────────┴────────────┴───────────┴───────────────┘