Saltar al contenido principal

Documentación

Guía para conectar repositorios, generar API keys y enviar resultados de pruebas de CI a Qably según el contrato de la API.

Cómo funciona Qably

Qably centraliza la gestión de calidad para equipos de ingeniería. La plataforma no ejecuta pruebas directamente: los resultados se generan en pipelines externos de integración continua y se envían a Qably vía HTTP. El sistema almacena las ejecuciones y consolida el historial de pruebas, las suites y los cambios del repositorio.

Dos flujos independientes

Qably procesa dos flujos de datos desacoplados. Configurar uno no activa el otro, lo cual explica por qué ciertas vistas pueden aparecer vacías inicialmente.

PipelineEndpointCredencialLlena
Resultados de pruebasPOST /runs/ingestAPI key del proyecto (Authorization: Bearer)Suites, casos y ejecuciones en el panel principal
Cambios de códigoPOST /webhooks/scm/:providerFirma HMAC (sin API key)Historial de commits, lotes de ingesta y trazabilidad en la vista Repository

El CI ejecuta las pruebas y genera un reporte JUnit XML o JSON. Envía el reporte a la API de ingesta de Qably con una API key del proyecto. Qably guarda las ejecuciones y sus casos y los muestra en el panel y en las notificaciones. Qably nunca ejecuta las pruebas.

  1. Tu CI: Ejecuta las pruebas
  2. Tu CI: Reporte JUnit XML o JSON. Luego: API key
  3. Qably: API de ingesta - POST /runs/ingest y /runs/ingest/junit
  4. Qably: Ejecuciones y casos
  5. Qably: Panel y notificaciones
Diagrama: Flujo de resultados de pruebasQably no ejecuta las pruebas: recibe el reporte que genera el CI.

Un push o pull request en GitHub envía un webhook firmado con HMAC al endpoint de webhooks de Qably. Qably guarda la entrega como un lote de ingesta con sus commits y archivos cambiados, y la muestra en la vista Repository y como commits candidatos al comparar ejecuciones.

  1. Tu repositorio: Push o pull request en GitHub. Luego: Firma HMAC
  2. Qably: Endpoint del webhook - POST /webhooks/scm/:provider
  3. Qably: Lotes de ingesta - Commits y archivos cambiados
  4. Qably: Vista Repository - Y el rango de commits candidatos al comparar ejecuciones
Diagrama: Flujo de cambios de códigoLos commits candidatos también requieren que las ejecuciones comparadas informen su commitSha.

Importante: El envío de resultados de pruebas desde CI no alimenta la vista Repository, y conectar un repositorio no registra ejecuciones de prueba. Si una pantalla no muestra información, verifique cuál de los dos flujos debe suministrarla.

Requisitos previos

  • Una cuenta en Qably con al menos una organización activa.
  • Un repositorio alojado en GitHub, el único proveedor de repositorios compatible actualmente.
  • Un pipeline de CI con capacidad de ejecutar pruebas y enviar peticiones HTTP al concluir.