yolo_distributed/tests/conftest.py
Glenn Jocher 158ced9c17
ultralytics 8.4.58 Isolated CI export environments (#24649)
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
2026-05-31 19:23:43 +08:00

135 lines
4.9 KiB
Python

# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
import shutil
from pathlib import Path
import numpy.testing # noqa: F401 # Pre-import before any test can corrupt numpy via in-place upgrade
import pytest
@pytest.fixture(scope="session")
def solution_assets():
"""Return cached solution asset paths by name."""
from tests import SOLUTION_ASSETS
from ultralytics.utils import ASSETS_URL, WEIGHTS_DIR
from ultralytics.utils.downloads import safe_download
cache_dir = WEIGHTS_DIR / "solution_assets"
cache_dir.mkdir(parents=True, exist_ok=True)
def get_asset(name):
asset_path = cache_dir / SOLUTION_ASSETS[name]
if not asset_path.exists():
safe_download(url=f"{ASSETS_URL}/{asset_path.name}", dir=cache_dir)
return asset_path
return get_asset
def pytest_addoption(parser):
"""Add custom command-line options to pytest."""
parser.addoption("--slow", action="store_true", default=False, help="Run slow tests")
parser.addoption(
"--export-env",
default=None,
help="Run only export tests assigned to this export environment id.",
)
def _export_format_from_item(item, formats):
"""Infer the export format covered by a tests/test_exports.py item."""
if Path(str(item.fspath)).name != "test_exports.py":
return None
name = getattr(item, "originalname", None) or item.name.split("[", 1)[0]
if name == "test_torch2onnx_serializes_concurrent_exports":
return "onnx"
if not name.startswith("test_export_"):
return None
suffix = name[len("test_export_") :]
return next(
(fmt for fmt in sorted(formats, key=len, reverse=True) if suffix == fmt or suffix.startswith(f"{fmt}_")), None
)
def pytest_collection_modifyitems(config, items):
"""Modify the list of test items to exclude tests marked as slow if the --slow option is not specified.
Args:
config: The pytest configuration object that provides access to command-line options.
items (list): The list of collected pytest item objects to be modified based on the presence of --slow option.
"""
if not config.getoption("--slow"):
# Remove the item entirely from the list of test items if it's marked as 'slow'
items[:] = [item for item in items if "slow" not in item.keywords]
export_env = config.getoption("--export-env")
if not export_env:
return
from ultralytics.engine.exporter import export_formats
env_by_format = dict(zip(export_formats()["Argument"], export_formats()["Env"]))
for item in items:
fmt = _export_format_from_item(item, env_by_format)
if fmt and env_by_format.get(fmt) != export_env:
item.add_marker(pytest.mark.skip(reason=f"export format '{fmt}' belongs to env '{env_by_format[fmt]}'"))
def pytest_sessionstart(session):
"""Initialize session configurations for pytest.
This function is automatically called by pytest after the 'Session' object has been created but before performing
test collection. It sets the initial seeds for the test session.
Args:
session: The pytest session object.
"""
from ultralytics.utils.torch_utils import init_seeds
init_seeds()
@pytest.fixture
def isolated_model(tmp_path):
"""Provide an isolated copy of the test model to prevent export file races under pytest-xdist.
When multiple xdist workers run export tests simultaneously, they derive output filenames from the model path (e.g.,
model.onnx, model.torchscript). Using the same MODEL path causes workers to overwrite each other's
intermediate/export files. This fixture copies the shared model to a per-test temporary directory so each test
exports to a unique path.
"""
from tests import MODEL
if not Path(MODEL).exists():
from ultralytics.utils.downloads import attempt_download_asset
MODEL.parent.mkdir(parents=True, exist_ok=True)
shutil.copy(attempt_download_asset("yolo26n.pt"), MODEL)
dst = tmp_path / "model.pt"
shutil.copy(MODEL, dst)
return str(dst)
def pytest_sessionfinish(session, exitstatus):
"""Cleanup operations after pytest session.
Runs only on the pytest controller (or serial run), skipping xdist workers to avoid race conditions where one worker
deletes shared assets while another is still reading them.
"""
# Skip on xdist workers - only the controller should clean up shared resources
if hasattr(session.config, "workerinput"):
return
from ultralytics.utils import WEIGHTS_DIR
# Remove files
models = [path for x in {"*.onnx", "*.torchscript"} for path in WEIGHTS_DIR.rglob(x)]
for file in ["decelera_portrait_min.mov", "bus.jpg", "yolo26n.onnx", "yolo26n.torchscript", *models]:
Path(file).unlink(missing_ok=True)
# Remove directories
for directory in [path for x in {"*.mlpackage", "*_openvino_model"} for path in WEIGHTS_DIR.rglob(x)]:
shutil.rmtree(directory, ignore_errors=True)