[devel] I: API for girar tasks

[devel] I: API for girar tasks

[Anton Farygin]

Привет.

На git.altlinux.org начал работать сервис, отдающий данные о задачах 
girar по HTTP в JSON.

  https://git.altlinux.org/tasks/api/openapi.json

Зачем это было делать.

girar task ls и girar task show --json работают по SSH и каждый раз 
читают файловую систему. Это медленно и неудобно, если хочется делать
автоматизацию, писать ботов, мониторинг или просто быстро посмотреть 
состояние задач из скрипта. taskoteka держит все задачи в памяти 
иобновляет кеш раз в 5 секунд, ответы приходят мгновенно и для доступа к 
информации не нужно участие в ALT Linux Team с доступом к ssh.

Примеры использования:

Список задач с фильтрами:

  # Активные задачи (AWAITING, BUILDING, COMMITTING, FAILING, PENDING, 
POSTPONED)
  curl -s https://git.altlinux.org/tasks/api/tasks | jq .

  # Задачи конкретного пользователя
  curl -s 'https://git.altlinux.org/tasks/api/tasks?user=rider'

  # EPERM в p11
  curl -s 'https://git.altlinux.org/tasks/api/tasks?state=EPERM&repo=p11'

  # Несколько стейтов
  curl -s 'https://git.altlinux.org/tasks/api/tasks?state=BUILDING,FAILING'

Полнотекстовый поиск — ищет по id, owner, repo, стейту, message
и полям сабтасков (pkgname, dir, tag_name):

  # Найти EPERM задачи в p11 с "lib" в имени пакета
  curl -s 'https://git.altlinux.org/tasks/api/tasks?q=p11+EPERM+lib'

В ответе приходит поле matches, где видно, в каких полях совпало.

Задачи, ожидающие approve:

  # EPERM задачи, которым не хватает approve мейнтейнера
  curl -s 'https://git.altlinux.org/tasks/api/tasks?needs_approval=maint'

  # То же для тестировщиков, только p11
  curl -s 
'https://git.altlinux.org/tasks/api/tasks?needs_approval=tester&repo=11'

Полная информация о задаче (формат совместим с girar task show --json):

  curl -s https://git.altlinux.org/tasks/api/tasks/389466 | jq .

Включает статус сборки по архитектурам, комментарии 
approved_by/disapproved_by
с датами, EVR пакетов.

Server-Sent Events — подписка на изменения в реальном времени:

  curl -N https://git.altlinux.org/tasks/api/events

Приходят события task_new, task_updated, task_removed — удобно для 
ботов и дашбордов, не надо поллить.

Список владельцев задач:

  curl -s https://git.altlinux.org/tasks/api/owners

Формат ответа стандартный JSON. В заголовках приходит x-api-version и 
x-cache-age

(сколько секунд назад обновился кеш). OpenAPI-спецификация доступна
по GET /openapi.json — можно загрузить в Swagger UI.


Все данные в памяти, кеш обновляется раз в 5 секунд. Ответы на запросы —
меньше миллисекунды. Архивные задачи читаются с диска по запросу.

Исходники, баги и пожелания:
https://altlinux.space/rider/taskoteka

OCaml, лицензия GPL-2.0-or-later.