qadesk.ru / Автотесты из CI / qadesk-cli

Автотесты · утилита

qadesk-cli — отчёты автотестов в QA Деск из CI

Обновлено: 7 октября 2026

Один статический бинарник без зависимостей. Находит отчёты JUnit XML, Allure или JSON измерений qadesk в каталоге, отправляет их в QA Деск и печатает ссылку на прогон последней строкой. Код выхода честный: падение тестов на него не влияет — это дело CI-гейта, утилита отвечает за то, что отчёт дошёл.

  1. Токен приёмаQADESK_TOKEN проекта — только из окружения
  2. Файлы отчётаJUnit XML, Allure или *.qadesk.json
  3. qadesk-cli uploadФормат определяется автоматически
  4. Прогон в проектеРезультаты, замеры по шагам, версии прошивок
  5. Вердикт по допускуСчитает QA Деск, а не CI
Что делает qadesk-cli: от файла отчёта до вердикта в QA Деск

Скачать

Текущая версия — 0.8.0 от 16 ноября 2026: команда observations import принимает выгрузку установок AOI, SPI, рентгена и ICT — дефекты по позиции на серийной плате (ниже). С 0.7.0 — флаг --unit кладёт прогон на экземпляр устройства и закрывает срок его периодической проверки (ниже). С 0.6.0 — команда scpi снимает числа с настольных приборов в шаги кейса (ниже). С 0.5.0 — флаг --plan (ниже). С 0.4.0 — сводки нагрузочных прогонов k6, JMeter и Gatling (ниже). С 0.3.0 — формат qadesk для измерений и флаг --stack для версий (ниже).

Установленную покажет qadesk-cli version, опубликованную — /cli/VERSION. Исходники — модуль tools/qadesk-cli в репозитории QA Деск (Go 1.23).

curl -fsSL https://qadesk.ru/cli/qadesk-cli-linux-amd64 -o /usr/local/bin/qadesk-cli
chmod +x /usr/local/bin/qadesk-cli
qadesk-cli version

Токен

QADESK_TOKEN — токен приёма проекта (qdit_…): кабинет → Настройки → Интеграции → CI / автотесты, при выбранном проекте. Показывается один раз, называйте по пайплайну. Только из окружения: флагом не принимается, чтобы не светиться в логе CI. Личные токены qdpt_ и JWT не подходят — утилита скажет об этом до отправки.

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

qadesk-cli upload [флаги] <путь>...

Путь — файл или каталог (рекурсивно). Формат по умолчанию auto: есть *.qadesk.json — формат qadesk, иначе есть *-result.json — Allure, иначе JUnit по *.xml. Несколько XML-файлов (Surefire, pytest-xdist) или несколько *.qadesk.json склеиваются в один отчёт.

--format junit|allure|qadesk|autoформат отчёта
--run "имя"имя прогона; по умолчанию — из CI (bitrix-qa regress #12) или имя каталога и время
--env, --platform, --buildprod|stage|test|dev|local; web|ios|android|desktop|api; сборка до 64 символов
--stack ключ=версияверсия компонента прошивочного стека прогона: --stack bios=1.2.3 --stack bmc=4.5; повторяемый, ключи — из справочника проекта «Железо и прошивки», форма пары проверяется до отправки
--plan UUID, --unit UUIDплан и экземпляр устройства: UUID или ссылки из кабинета; --unit — с версии 0.7.0, требует --plan, несовместим с --target-run
--ci-run-id, --attemptключ идемпотентности; по умолчанию — из переменных CI
--ci-urlссылка на сборку; по умолчанию — из переменных CI или QADESK_CI_URL
--no-ciне читать переменные CI — без ключа и без ссылки на сборку
--strictкод 3, если часть тестов не легла в прогон
--jsonstdout — только ответ сервера; ход отправки — в stderr
--urlадрес API (иначе QADESK_URL, иначе https://api.qadesk.ru) — для Коробки
--timeout 2m, --retries 3таймаут попытки; повторы при сети и 502/503/504
--quietтолько ошибки и ссылка

Коды выхода: 0 — принят (или уже был принят раньше — утилита скажет об этом вслух); 1 — не дошёл (сеть, 5xx после повторов); 2 — ошибка данных (нет токена или файлов, битый XML или JSON, --stack без =, 401/409/422/413 — в том числе stack_key_unknown на ключ стека не из справочника); 3 — только с --strict, есть несматченные тесты.

Несматченные тесты не записываются и всегда печатаются поимённо: результат ложится в прогон только через ключ кейса (QAD-C17) в имени теста, property qadesk.case (JUnit) или label qadesk_case (Allure). Ответ 200 без тела контракта (так отвечает SPA-фолбэк на неверный адрес) утилита считает ошибкой, а не успехом.

Как отправить из CI измерения и версии прошивок?

С версии 0.3.0 — файлом *.qadesk.json и флагом --stack. В файле — результат теста и числа по шагам измерительного кейса (step — номер шага с 1). Вердикт по допуску шага считает QA Деск, а не CI: число вне допуска валит строку даже при "status": "passed".

{ "results": [
  { "name": "thermal load", "caseKey": "SRV-C12", "status": "passed",
    "durationMs": 600000,
    "metrics": [ { "step": 2, "value": 72.5 }, { "step": 3, "value": 12.4 } ] }
] }
qadesk-cli upload --run "burn-in стенд 3" --stack bios=1.2.3 --stack bmc=4.5 ./out

Поля status (по умолчанию passed) и caseKey (иначе ключ ищется в name) необязательны; value — конечное число; неизвестное поле — ошибка, чтобы опечатка не потеряла числа молча. Утилита печатает строку «→ измерения: N легли на шаги, M вне допуска» и поимённо — метрики, которые не легли (no_step — нет такого шага, step_not_measured — у шага нет допуска). Версии стека пишутся снимком на прогон и попадают в матрицу совместимости и тренд замеров. Модель данных, допуски и матрица — в документации «Железо и прошивки».

Как отправить нагрузочный прогон k6, JMeter или Gatling?

С версии 0.4.0 — флагом --format k6-summary, jmeter-jtl или gatling: утилита сама сворачивает сводку инструмента в формат qadesk. Транзакция (сценарий k6, label JMeter, запрос Gatling) становится строкой прогона, p50, p95, p99, запросы в секунду и доля ошибок в процентах — числами на измерительных шагах кейса.

Вердикт по допуску («p95 ≤ 800 мс», «ошибок ≤ 1 %») считает QA Деск, а тренд на карточке кейса показывает, на какой версии приложения вырос p95.

k6 run --summary-export=summary.json checkout.js
qadesk-cli upload --format k6-summary --case QAD-C31 --stack app=2.4.1 --run "checkout load" summary.json

jmeter -n -t plan.jmx -l out/result.jtl
qadesk-cli upload --format jmeter-jtl --stack app=2.4.1 --run "checkout load" ./out

qadesk-cli upload --format gatling --run "checkout load" ./target/gatling/checkout-20260928
qadesk-cli convert --format k6-summary summary.json   # посмотреть JSON, без токена и сети

По умолчанию показатели ложатся на шаги 1–5 в порядке p50, p95, p99, rps, ошибки; другой порядок — --load-steps p95=1,errors=2. Ключ кейса — в имени транзакции (QAD-C31 checkout); сводке k6 без разбивки по сценариям ключ даёт --case. Показатель, которого нет в сводке (k6 по умолчанию не считает p99), не выдумывается — утилита предупреждает и число не отправляет. JMeter — CSV JTL со строкой заголовка, Gatling — js/stats.json отчёта (перцентили из gatling.conf, флаг --gatling-percentiles). Генерация нагрузки и сырые графики остаются у инструмента — в QA Деск уходит только сводка.

Как снять показания мультиметра или источника питания прямо в прогон?

С версии 0.6.0 — командой qadesk-cli scpi. Она спрашивает прибор по сети через SCPI-сокет (порт 5025, у Rigol — 5555) и пишет числа в файл формата qadesk, который уходит обычной загрузкой. Каждое число помечено «с прибора» и несёт ответ прибора на *IDN?: в протоколе испытаний видно, что значение снято прибором, а не набрано руками.

QA Деск сверяет серийный номер из ответа прибора с карточкой средства измерений. Отвечает другой прибор — в ответе загрузки предупреждение, и число приписывается тому прибору, который ответил, а не чужой поверке. Поверка истекла — число записано с отметкой «недостоверно» и предупреждением.

qadesk-cli scpi idn 192.168.1.50          # модель и серийник: связь есть
qadesk-cli scpi read --profile bench.json --out out/bench.qadesk.json
qadesk-cli upload --format qadesk out/
{"instruments": {"dmm": {"address": "192.168.1.50", "serial": "MY59001234"}},
 "results": [{"caseKey": "KV-C12", "name": "Питание платы",
              "measurements": [{"step": 3, "instrument": "dmm", "query": "MEAS:VOLT:DC?"}]}]}

Профиль стенда — какой прибор на каком шаге и что у него спросить. Запрос один на шаг и только вопрос (оканчивается на «?»): прибором и стендом утилита не управляет. Перегрузка прибора не превращается в число — строка прогона помечается проваленной с пояснением. Подключение — только по сети; VXI-11, HiSLIP, USB и GPIB пока не поддержаны.

Как засчитать учения DR или проверку восстановления в срок регулярной проверки?

С версии 0.5.0 — флагом --plan с UUID тест-плана или ссылкой на него из кабинета. Прогон, который пришлёт скрипт, ложится завершённой проверкой этого плана: у плана с расписанием срок следующей проверки пересчитывается от неё, а отметка «проверка просрочена» снимается с карточки плана и с рабочего стола проектов.

Время восстановления, RTO и RPO — числами на измерительных шагах кейса, версии ОС и СУБД — флагом --stack.

./dr-restore.sh && qadesk-cli upload --plan https://app.qadesk.ru/projects/…/plans/<uuid> \
  --run "dr-restore $(date +%F)" --stack os=astra-1.8 --stack pg=16.4 ./out

План должен быть в проекте токена и не в архиве: чужой план — ответ 422 plan_not_in_project, архивный — 409; --plan не сочетается с --target-run. Расписание («раз в квартал», ответственный, за сколько дней создавать прогон) задаётся в карточке плана.

Как загрузить дефекты с AOI, SPI, рентгена или ICT по позиции на плате?

С версии 0.8.0 — командой observations import. Она читает CSV установки контроля: серийный номер платы, позиционное обозначение (R12, U3), тип дефекта, по желанию компонент, время и идентификатор строки. Каждая строка становится наблюдением на экземпляре платы: оператор в кабинете подтверждает его или отмечает ложное срабатывание, а Парето по типам дефектов, позициям, компонентам и линиям и доля ложных срабатываний считаются по партии.

export QADESK_API_TOKEN=qdpt_…   # личный токен из профиля; токен приёма qdit_ сюда не подходит
qadesk-cli observations import --dry-run --source aoi aoi-smt2.csv
qadesk-cli observations import --workspace <uuid|ссылка> --project <uuid|ссылка> \
  --source aoi --line SMT-2 --batch <uuid> aoi-smt2.csv

Файл проверяется целиком до отправки: кодировка UTF-8, обязательные колонки, словарь типов дефекта, длины полей, время ISO-8601 с часовым поясом. Ошибка — список «строка N файла: причина», и на сервер ничего не уходит. Строки отправляются пачками до 5000; плата, которой нет в проекте, возвращается с номером строки файла и причиной. Повторная загрузка того же файла с колонкой external_id не создаёт дублей. Колонки, синонимы заголовков и коды выхода — в qadesk-cli observations import --help.

Идемпотентность и ссылка на сборку

Повтор загрузки — сеть моргнула, задание перезапустили — не создаёт второй прогон, если передан ключ «прогон CI + попытка». Вместе с ключом утилита передаёт систему, ссылку на сборку, коммит и ветку: в карточке прогона появляется строка «Сборка: Jenkins · regress #412 ↗», ветка и короткий коммит, в списке прогонов — система CI. Всё берётся из окружения:

GitHub Actionsключ GITHUB_RUN_ID + GITHUB_RUN_ATTEMPT; ссылка на запуск собирается из GITHUB_SERVER_URL и GITHUB_REPOSITORY
GitLab CIключ CI_PIPELINE_ID; ссылка CI_PIPELINE_URL
SourceCraft CIключ SOURCECRAFT_RUN_ID; ссылки в окружении нет — QADESK_CI_URL
Jenkinsключ BUILD_TAG; ссылка BUILD_URL
TeamCityключ — конфигурация + BUILD_NUMBER; ссылки в окружении нет — QADESK_CI_URL=%teamcity.serverUrl%/build/%teamcity.build.id%
Azure Pipelinesключ BUILD_BUILDID; ссылка на результаты сборки собирается из коллекции и проекта
CircleCIключ CIRCLE_WORKFLOW_ID (у параллельных узлов — свой); ссылка CIRCLE_BUILD_URL
Woodpeckerключ CI_PIPELINE_NUMBER, попытка из CI_PIPELINE_RERUNS; ссылка CI_PIPELINE_URL
Buildkiteключ BUILDKITE_BUILD_ID; ссылка BUILDKITE_BUILD_URL
Bitbucket Pipelinesключ BITBUCKET_BUILD_NUMBER; ссылки нет — QADESK_CI_URL
Bambooключ bamboo_buildResultKey; ссылка bamboo_resultsUrl
GitFlic, Gitea, Forgejoкак GitLab и GitHub соответственно; в карточке — под своим именем, а не как GitLab или GitHub
прочиеQADESK_CI_RUN_ID + QADESK_CI_ATTEMPT, ссылка QADESK_CI_URL

Ключ проверен живыми прогонами в GitHub, GitLab и SourceCraft; переменные остальных систем сверены с их документацией. QADESK_CI_URL перекрывает догадку утилиты — например, когда Jenkins за прокси отдаёт внутренний адрес. Ссылку не http(s) и «коммит» не из шестнадцатеричных символов утилита не отправляет и говорит об этом в журнале: сервер отверг бы весь отчёт.

Там, где CI ключа не даёт, утилита его не выдумывает — ключ из даты молча выключил бы защиту от дублей. Тот же ключ с другим отчётом (шард матрицы, перезапуск тестов) — отказ 409: передайте свой --attempt или свой --ci-run-id на шард.

Примеры

GitLab CI / GitFlic (QADESK_TOKEN — в CI/CD Variables, masked):

report:
  stage: report
  when: always
  script:
    - curl -fsSL https://qadesk.ru/cli/qadesk-cli-linux-amd64 -o qadesk-cli && chmod +x qadesk-cli
    - ./qadesk-cli upload --run "$CI_PROJECT_NAME regress" --env stage ./reports

GitHub Actions:

- name: Отчёт в QA Деск
  if: always()
  env:
    QADESK_TOKEN: ${{ secrets.QADESK_TOKEN }}
  run: |
    curl -fsSL https://qadesk.ru/cli/qadesk-cli-linux-amd64 -o qadesk-cli && chmod +x qadesk-cli
    ./qadesk-cli upload --format allure ./allure-results

Локально: QADESK_TOKEN=qdit_… qadesk-cli upload --no-ci ./allure-results. Без утилиты тот же приём работает одним curl — см. Автотесты из CI.

Что вы получите на выходе после загрузки?

Утилита не запускает тесты: она забирает готовые отчёты — JUnit XML, Allure, JSON qadesk, сводки k6, JMeter и Gatling — и кладёт их в QA Деск. На выходе — завершённый прогон, в котором каждый результат лежит на своём тест-кейсе, а последняя строка вывода утилиты — ссылка на этот прогон:

qadesk-cli v0.5.0: отчёт junit, файлов 3, результатов 162 → https://api.qadesk.ru
прогон «bitrix-qa regress #41», ключ идемпотентности 4821 (GitLab CI)
→ прогон «bitrix-qa regress #41»: 154 пройдено · 5 упало · 3 пропущено (сматчено 162, схлопнуто 0)
⚠ не сматчено на кейсы 4 — НЕ записаны: case_archived 1, no_key 3
→ https://app.qadesk.ru/projects/…/runs/…

1. Прогон с результатами по кейсам. В списке прогонов проекта появляется завершённый прогон с именем, окружением, платформой, сборкой и системой CI; в карточке — ссылка на сборку, ветка и коммит. Каждая строка — тест-кейс проекта с итогом «пройден», «упал» или «пропущен»; у упавшего — сообщение об ошибке из отчёта. Результат ложится в прогон только по ключу кейса (QAD-C17) в имени теста или в метке: тесты без ключа не записываются, а утилита печатает их поимённо (в примере выше — четыре).

Прогон автотестов из CI в QA Деск: отчёт разложен по кейсам проекта
Отчёт e2e Playwright из GitLab CI, разложенный по кейсам проекта. Демо-пространство «ТехноВектор»

2. Тренд измерений на карточке кейса. Если в отчёте есть числа (формат qadesk, нагрузка k6, JMeter, Gatling), они ложатся на шаги кейса с допуском. Вердикт считает QA Деск, а не CI, а на карточке кейса — тренд по прогонам с подписью версий стека: видно, на какой прошивке или сборке значение вышло за допуск.

Тренд измерения температуры по прогонам с допуском 85 °C на карточке кейса
Температура платы по девяти прогонам: красные точки — выход за допуск 85 °C. Демо-пространство «ТехноВектор»

3. Матрица стека. Версии, переданные флагом --stack, сохраняются снимком на прогон и попадают в матрицу совместимости: строки и колонки — компоненты стека (прошивка, BIOS, BMC), в клетке — результат по худшему прогону. Стек и матрица есть в проектах типа «Железо и прошивки».

Матрица совместимости: результат испытаний по версиям прошивки и BIOS
Матрица совместимости по версиям прошивки. Демо-пространство «ТехноВектор»

4. Привязка к изделию. С версии 0.7.0 передайте --plan и --unit: завершённый прогон ляжет на план и экземпляр и закроет срок периодической проверки этой пары. Оба ключа принимают UUID или ссылку из кабинета. --unit требует --plan и не сочетается с --target-run. Чужой экземпляр — 404, списанный — 422. Экземпляры устройств — в документации «Железо и прошивки».

qadesk-cli upload --plan <UUID-плана> --unit <UUID-экземпляра> report.xml

5. Артефакты. Утилита не загружает файлы: логи железа (SEL, dmesg, консоль, fio, memtest) прикладываются к дефекту в кабинете, и QA Деск показывает по ним сводку.

Что из Allure не переносится. Из результата Allure берутся имя, статус, сообщение об ошибке, метки и время. Шаги внутри теста и вложения (скриншоты, логи) в QA Деск не попадают — они остаются в исходном отчёте Allure. Поэтому карточка результата у QA Деск беднее, чем у самого Allure: детальный разбор шагов смотрите там, а в QA Деск — итог, связь с кейсом, тренд и дефекты.

Попробуйте QA Деск на своих процессах

Зарегистрируйтесь и заведите первый проект за пару минут — или поставьте приложение на портал Битрикс24 и получите пространство с сотрудниками и группами сразу. Нужно живое демо на сценариях вашей команды — напишите нам.

Попробовать

Демо-проект с кейсами и дефектами · перенос кейсов из TestIT и CSV · внедрение силами команды Эм Си Арт