Flujo de trabajo de CI/pruebas 🧪

La integración continua (CI) es esencial para mantener un código de alta calidad al detectar problemas a tiempo. Esta guía cubre las pruebas de CI y las comprobaciones de calidad para los proyectos de Ultralytics.

Acciones de CI 🔄

Todos los PR deben superar las comprobaciones automáticas de CI antes de fusionarse. Nuestro pipeline de CI incluye:

Pruebas de CI

Prueba de CI principal que ejecuta pruebas unitarias, comprobaciones de estilo (linting) y pruebas exhaustivas.

Despliegue de Docker

Valida el despliegue usando Docker, asegurando que el Dockerfile y los scripts relacionados funcionen correctamente.

Enlaces rotos

Escanea el código base en busca de enlaces rotos o muertos en archivos markdown y HTML.

Análisis de CodeQL

Herramienta de análisis semántico de GitHub para encontrar posibles vulnerabilidades de seguridad y mantener la calidad del código.

Publicación en PyPI

Valida que el proyecto se pueda empaquetar y publicar en PyPI sin errores.

Pruebas de plataforma 🖥️

Las pruebas se ejecutan en múltiples entornos:

SO: Ubuntu, Windows, macOS
Python: 3.8, 3.9, 3.10, 3.11, 3.12

Cobertura de código 📊

Usamos Codecov para medir y visualizar la cobertura de código, proporcionando información sobre qué tan bien cubren las pruebas el código base.

Integración de cobertura

La integración de Codecov proporciona:

Información detallada sobre la cobertura
Comparaciones de cobertura entre commits
Superposiciones visuales en el código que muestran las líneas cubiertas
Porcentaje de cobertura para el paquete ultralytics

Consulta todos los detalles de cobertura en codecov.io/github/ultralytics/ultralytics.

Entendiendo la cobertura

La cobertura de código muestra qué porcentaje del código se ejecuta durante las pruebas. Una cobertura alta indica un código bien probado, pero no garantiza la ausencia de errores. La cobertura ayuda a identificar áreas no probadas que podrían ser propensas a errores.

Ejecutar pruebas localmente 🖥️

Instalar dependencias de desarrollo

pip install -e ".[dev]"

Ejecutar todas las pruebas

pytest tests/

Ejecutar pruebas específicas

# Single file
pytest tests/test_engine.py

# Single test function
pytest tests/test_engine.py::test_train

# Tests matching pattern
pytest -k "export"

# Slow tests only
pytest -m slow

Ejecutar con cobertura

pytest --cov=ultralytics tests/

Pruebas en paralelo

# Install pytest-xdist
pip install pytest-xdist

# Run tests in parallel
pytest -n auto

Escribir pruebas ✍️

Estructura de las pruebas

from pathlib import Path

from ultralytics import YOLO

def test_model_export():
    """Test ONNX model export."""
    model = YOLO("yolo26n.pt")
    model.export(format="onnx")
    assert Path("yolo26n.onnx").exists()

Buenas prácticas

Nombres descriptivos: test_export_onnx_format() no test_1()
Aserción única: Prueba una sola cosa por función
Pruebas rápidas: Usa modelos/datasets pequeños
Fixtures: Usa fixtures de pytest para setup/teardown
Markers: @pytest.mark.slow para pruebas de larga duración

Organización de las pruebas

tests/
├── test_engine.py      # Training, validation, prediction
├── test_nn.py          # Model architecture
├── test_data.py        # Dataset handling
├── test_utils.py       # Utility functions
└── test_exports.py     # Export formats

Marcadores de prueba

import pytest

@pytest.mark.slow
def test_full_training():
    """Test full training run (slow)."""
    model = YOLO("yolo26n.pt")
    model.train(data="coco128.yaml", epochs=1)

Comprobaciones de calidad del código 🎯

Formateo con Ruff

# Check formatting
ruff check ultralytics/

# Auto-fix issues
ruff check --fix ultralytics/

# Format code
ruff format ultralytics/

Aprende más sobre los estándares de código en nuestro flujo de trabajo de desarrollo.

Comprobación de tipos

# Run mypy (where configured)
mypy ultralytics/

Formateo de docstrings

pip install ultralytics-actions

# Auto-fix
ultralytics-actions-format-python-docstrings .

Solución de problemas de CI 🔧

Las pruebas pasan localmente pero fallan en CI

Causas comunes:

Problemas específicos de la plataforma: Prueba en el SO de destino
Diferencias en la versión de Python: Comprueba la compatibilidad de versiones
Dependencias faltantes: Verifica la configuración de CI
Problemas de tiempo/concurrencia: Añade reintentos o aumenta los tiempos de espera (timeouts)