conftest.py 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602
  1. """Shared test fixtures for BamBuddy backend tests."""
  2. import asyncio
  3. import atexit
  4. import json
  5. import logging
  6. import os
  7. import shutil
  8. import tempfile
  9. from collections.abc import AsyncGenerator
  10. from pathlib import Path
  11. from unittest.mock import AsyncMock, MagicMock, patch
  12. import pytest
  13. # IMPORTANT: Set environment variables BEFORE any app imports
  14. # This must happen before settings/config are loaded
  15. os.environ["LOG_TO_FILE"] = "false"
  16. os.environ["DEBUG"] = "false"
  17. from httpx import ASGITransport, AsyncClient # noqa: E402
  18. from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine # noqa: E402
  19. # Ensure settings use our env vars - import and override before database import
  20. from backend.app.core.config import settings # noqa: E402
  21. settings.log_to_file = False
  22. # Use a temp directory for plate calibration to avoid deleting real calibration files
  23. _test_plate_cal_dir = Path(tempfile.mkdtemp(prefix="bambuddy_test_plate_cal_"))
  24. settings.plate_calibration_dir = _test_plate_cal_dir
  25. # Clean up temp directory when tests finish
  26. def _cleanup_test_plate_cal_dir():
  27. if _test_plate_cal_dir.exists():
  28. shutil.rmtree(_test_plate_cal_dir, ignore_errors=True)
  29. atexit.register(_cleanup_test_plate_cal_dir)
  30. from backend.app.core.database import Base # noqa: E402
  31. # Use in-memory SQLite for tests
  32. TEST_DATABASE_URL = "sqlite+aiosqlite:///:memory:"
  33. @pytest.fixture(scope="session")
  34. def event_loop():
  35. """Create an instance of the default event loop for each test session."""
  36. loop = asyncio.get_event_loop_policy().new_event_loop()
  37. yield loop
  38. # Dispose the module-level engine so aiosqlite worker threads finish
  39. # before the event loop closes, preventing "Event loop is closed" errors.
  40. from backend.app.core.database import engine
  41. loop.run_until_complete(engine.dispose())
  42. loop.run_until_complete(asyncio.sleep(0.05))
  43. loop.close()
  44. @pytest.fixture
  45. async def test_engine():
  46. """Create a test database engine."""
  47. engine = create_async_engine(TEST_DATABASE_URL, echo=False)
  48. # Import all models to register them
  49. from backend.app.models import (
  50. ams_history,
  51. ams_label,
  52. api_key,
  53. archive,
  54. external_link,
  55. filament,
  56. group,
  57. kprofile_note,
  58. maintenance,
  59. notification,
  60. notification_template,
  61. print_queue,
  62. printer,
  63. project,
  64. settings,
  65. smart_plug,
  66. spool,
  67. spool_assignment,
  68. spool_usage_history,
  69. user,
  70. )
  71. async with engine.begin() as conn:
  72. await conn.run_sync(Base.metadata.create_all)
  73. yield engine
  74. async with engine.begin() as conn:
  75. await conn.run_sync(Base.metadata.drop_all)
  76. await engine.dispose()
  77. # Allow aiosqlite's background thread to finish processing the close
  78. # response before the per-function event loop shuts down, preventing
  79. # "RuntimeError: Event loop is closed" in call_soon_threadsafe.
  80. await asyncio.sleep(0.1)
  81. @pytest.fixture
  82. async def db_session(test_engine) -> AsyncGenerator[AsyncSession, None]:
  83. """Create a test database session."""
  84. async_session_maker = async_sessionmaker(test_engine, class_=AsyncSession, expire_on_commit=False)
  85. async with async_session_maker() as session:
  86. yield session
  87. @pytest.fixture
  88. async def async_client(test_engine, db_session) -> AsyncGenerator[AsyncClient, None]:
  89. """Create an async test client."""
  90. from backend.app.core.database import async_session, get_db
  91. from backend.app.main import app
  92. # Create a new session maker for the test engine
  93. test_async_session = async_sessionmaker(test_engine, class_=AsyncSession, expire_on_commit=False)
  94. async def override_get_db():
  95. async with test_async_session() as session:
  96. yield session
  97. app.dependency_overrides[get_db] = override_get_db
  98. # Mock init_printer_connections to prevent MQTT connection attempts during tests
  99. async def mock_init_printer_connections(db):
  100. pass # No-op - don't connect to real printers
  101. # Also patch the module-level async_session used by services, auth, and middleware
  102. with (
  103. patch("backend.app.core.database.async_session", test_async_session),
  104. patch("backend.app.core.auth.async_session", test_async_session),
  105. patch("backend.app.main.async_session", test_async_session),
  106. patch("backend.app.main.init_printer_connections", mock_init_printer_connections),
  107. ):
  108. # Seed default groups for tests that need them
  109. from backend.app.core.database import seed_default_groups
  110. await seed_default_groups()
  111. async with AsyncClient(transport=ASGITransport(app=app), base_url="http://test") as client:
  112. yield client
  113. # The app lifespan called init_db() which used the module-level engine
  114. # (not the test engine), creating aiosqlite connections. Dispose those
  115. # connections so their background threads finish before the event loop closes.
  116. from backend.app.core.database import engine as real_engine
  117. await real_engine.dispose()
  118. app.dependency_overrides.clear()
  119. # ============================================================================
  120. # Mock External Services
  121. # ============================================================================
  122. @pytest.fixture
  123. def mock_tasmota_service():
  124. """Mock the Tasmota service for smart plug tests."""
  125. # Patch both the module where it's defined and where it's imported
  126. with (
  127. patch("backend.app.services.tasmota.tasmota_service") as mock,
  128. patch("backend.app.api.routes.smart_plugs.tasmota_service") as mock2,
  129. ):
  130. mock.turn_on = AsyncMock(return_value=True)
  131. mock.turn_off = AsyncMock(return_value=True)
  132. mock.toggle = AsyncMock(return_value=True)
  133. mock.get_status = AsyncMock(return_value={"state": "ON", "reachable": True, "device_name": "Test Plug"})
  134. mock.get_energy = AsyncMock(
  135. return_value={
  136. "power": 150.5,
  137. "voltage": 120.0,
  138. "current": 1.25,
  139. "today": 2.5,
  140. "total": 100.0,
  141. "factor": 0.95,
  142. }
  143. )
  144. mock.test_connection = AsyncMock(return_value={"success": True, "state": "ON", "device_name": "Test Plug"})
  145. # Copy mocks to second patch target
  146. mock2.turn_on = mock.turn_on
  147. mock2.turn_off = mock.turn_off
  148. mock2.toggle = mock.toggle
  149. mock2.get_status = mock.get_status
  150. mock2.get_energy = mock.get_energy
  151. mock2.test_connection = mock.test_connection
  152. yield mock
  153. @pytest.fixture
  154. def mock_homeassistant_service():
  155. """Mock the Home Assistant service for smart plug tests."""
  156. # Patch both the module where it's defined and where it's imported
  157. with (
  158. patch("backend.app.services.homeassistant.homeassistant_service") as mock,
  159. patch("backend.app.api.routes.smart_plugs.homeassistant_service") as mock2,
  160. ):
  161. mock.turn_on = AsyncMock(return_value=True)
  162. mock.turn_off = AsyncMock(return_value=True)
  163. mock.toggle = AsyncMock(return_value=True)
  164. mock.get_status = AsyncMock(return_value={"state": "ON", "reachable": True, "device_name": "Test HA Entity"})
  165. mock.get_energy = AsyncMock(return_value=None) # Most HA entities don't have power monitoring
  166. mock.test_connection = AsyncMock(return_value={"success": True, "message": "API running", "error": None})
  167. mock.list_entities = AsyncMock(
  168. return_value=[
  169. {
  170. "entity_id": "switch.printer_plug",
  171. "friendly_name": "Printer Plug",
  172. "state": "on",
  173. "domain": "switch",
  174. },
  175. {"entity_id": "switch.test", "friendly_name": "Test Switch", "state": "off", "domain": "switch"},
  176. ]
  177. )
  178. mock.configure = MagicMock()
  179. # Copy mocks to second patch target
  180. mock2.turn_on = mock.turn_on
  181. mock2.turn_off = mock.turn_off
  182. mock2.toggle = mock.toggle
  183. mock2.get_status = mock.get_status
  184. mock2.get_energy = mock.get_energy
  185. mock2.test_connection = mock.test_connection
  186. mock2.list_entities = mock.list_entities
  187. mock2.configure = mock.configure
  188. yield mock
  189. @pytest.fixture
  190. def mock_mqtt_client():
  191. """Mock the MQTT client for printer communication tests."""
  192. with patch("backend.app.services.bambu_mqtt.BambuMQTTClient") as mock:
  193. instance = MagicMock()
  194. instance.state = MagicMock(connected=True, state="IDLE", progress=0, temperatures={"nozzle": 25, "bed": 25})
  195. instance.connect = MagicMock()
  196. instance.disconnect = MagicMock()
  197. mock.return_value = instance
  198. yield mock
  199. @pytest.fixture
  200. def mock_mqtt_smart_plug_service():
  201. """Mock the MQTT smart plug service for MQTT plug tests."""
  202. with patch("backend.app.api.routes.smart_plugs.mqtt_relay") as mock:
  203. # Create a mock smart_plug_service
  204. mock_service = MagicMock()
  205. mock_service.is_configured = MagicMock(return_value=True)
  206. mock_service.has_broker_settings = MagicMock(return_value=True)
  207. mock_service.configure = AsyncMock(return_value=True)
  208. mock_service.subscribe = MagicMock()
  209. mock_service.unsubscribe = MagicMock()
  210. mock_service.get_plug_data = MagicMock(return_value=None)
  211. mock_service.is_reachable = MagicMock(return_value=False)
  212. mock.smart_plug_service = mock_service
  213. yield mock
  214. @pytest.fixture
  215. def mock_ftp_client():
  216. """Mock the FTP client for file transfer tests."""
  217. with (
  218. patch("backend.app.services.bambu_ftp.download_file_async") as download_mock,
  219. patch("backend.app.services.bambu_ftp.list_files_async") as list_mock,
  220. ):
  221. download_mock.return_value = True
  222. list_mock.return_value = []
  223. yield {"download": download_mock, "list": list_mock}
  224. @pytest.fixture
  225. def mock_httpx_client():
  226. """Mock httpx for webhook/notification HTTP calls."""
  227. with patch("httpx.AsyncClient") as mock_class:
  228. mock_instance = AsyncMock()
  229. mock_response = MagicMock()
  230. mock_response.status_code = 200
  231. mock_response.text = "OK"
  232. mock_response.json.return_value = {}
  233. mock_instance.get = AsyncMock(return_value=mock_response)
  234. mock_instance.post = AsyncMock(return_value=mock_response)
  235. mock_instance.__aenter__ = AsyncMock(return_value=mock_instance)
  236. mock_instance.__aexit__ = AsyncMock()
  237. mock_class.return_value = mock_instance
  238. yield mock_instance
  239. @pytest.fixture
  240. def mock_printer_manager():
  241. """Mock the printer manager for status checks."""
  242. with patch("backend.app.services.printer_manager.printer_manager") as mock:
  243. mock.get_status = MagicMock(
  244. return_value=MagicMock(
  245. connected=True,
  246. state="IDLE",
  247. progress=0,
  248. temperatures={"nozzle": 25, "bed": 25, "chamber": 25},
  249. raw_data={},
  250. )
  251. )
  252. mock.mark_printer_offline = MagicMock()
  253. yield mock
  254. # ============================================================================
  255. # Factory Fixtures for Test Data
  256. # ============================================================================
  257. @pytest.fixture
  258. def smart_plug_factory(db_session):
  259. """Factory to create test smart plugs."""
  260. async def _create_plug(**kwargs):
  261. from backend.app.models.smart_plug import SmartPlug
  262. # Determine defaults based on plug_type
  263. plug_type = kwargs.get("plug_type", "tasmota")
  264. defaults = {
  265. "name": "Test Plug",
  266. "plug_type": plug_type,
  267. "enabled": True,
  268. "auto_on": True,
  269. "auto_off": True,
  270. "off_delay_mode": "time",
  271. "off_delay_minutes": 5,
  272. "off_temp_threshold": 70,
  273. "schedule_enabled": False,
  274. "power_alert_enabled": False,
  275. }
  276. # Set required fields based on plug_type
  277. if plug_type == "homeassistant":
  278. defaults["ha_entity_id"] = "switch.test"
  279. defaults["ip_address"] = None
  280. elif plug_type == "mqtt":
  281. # Legacy fields (for backward compatibility tests)
  282. defaults["mqtt_topic"] = kwargs.get("mqtt_topic", "test/topic")
  283. defaults["mqtt_multiplier"] = kwargs.get("mqtt_multiplier", 1.0)
  284. # New separate topic/path/multiplier fields
  285. defaults["mqtt_power_topic"] = kwargs.get("mqtt_power_topic")
  286. defaults["mqtt_power_path"] = kwargs.get("mqtt_power_path", "power")
  287. defaults["mqtt_power_multiplier"] = kwargs.get("mqtt_power_multiplier", 1.0)
  288. defaults["mqtt_energy_topic"] = kwargs.get("mqtt_energy_topic")
  289. defaults["mqtt_energy_path"] = kwargs.get("mqtt_energy_path")
  290. defaults["mqtt_energy_multiplier"] = kwargs.get("mqtt_energy_multiplier", 1.0)
  291. defaults["mqtt_state_topic"] = kwargs.get("mqtt_state_topic")
  292. defaults["mqtt_state_path"] = kwargs.get("mqtt_state_path")
  293. defaults["mqtt_state_on_value"] = kwargs.get("mqtt_state_on_value")
  294. defaults["ip_address"] = None
  295. defaults["ha_entity_id"] = None
  296. else:
  297. defaults["ip_address"] = "192.168.1.100"
  298. defaults["ha_entity_id"] = None
  299. defaults.update(kwargs)
  300. plug = SmartPlug(**defaults)
  301. db_session.add(plug)
  302. await db_session.commit()
  303. await db_session.refresh(plug)
  304. return plug
  305. return _create_plug
  306. @pytest.fixture
  307. def printer_factory(db_session):
  308. """Factory to create test printers."""
  309. _counter = [0] # Use list to allow mutation in nested function
  310. async def _create_printer(**kwargs):
  311. from backend.app.models.printer import Printer
  312. _counter[0] += 1
  313. counter = _counter[0]
  314. defaults = {
  315. "name": "Test Printer",
  316. "serial_number": f"00M09A{counter:09d}", # Unique serial per printer
  317. "ip_address": f"192.168.1.{100 + counter}", # Unique IP per printer
  318. "access_code": "12345678",
  319. "is_active": True,
  320. "auto_archive": True,
  321. "model": "X1C",
  322. }
  323. defaults.update(kwargs)
  324. printer = Printer(**defaults)
  325. db_session.add(printer)
  326. await db_session.commit()
  327. await db_session.refresh(printer)
  328. return printer
  329. return _create_printer
  330. @pytest.fixture
  331. def notification_provider_factory(db_session):
  332. """Factory to create test notification providers."""
  333. async def _create_provider(**kwargs):
  334. from backend.app.models.notification import NotificationProvider
  335. config = kwargs.pop("config", {"server": "https://ntfy.sh", "topic": "test-topic"})
  336. if isinstance(config, dict):
  337. config = json.dumps(config)
  338. defaults = {
  339. "name": "Test Provider",
  340. "provider_type": "ntfy",
  341. "enabled": True,
  342. "config": config,
  343. "on_print_start": True,
  344. "on_print_complete": True,
  345. "on_print_failed": True,
  346. "on_print_stopped": True,
  347. "on_print_progress": False,
  348. "on_printer_offline": False,
  349. "on_printer_error": False,
  350. "on_filament_low": False,
  351. "on_maintenance_due": False,
  352. "on_ams_humidity_high": False,
  353. "on_ams_temperature_high": False,
  354. "on_bed_cooled": False,
  355. "quiet_hours_enabled": False,
  356. "daily_digest_enabled": False,
  357. }
  358. defaults.update(kwargs)
  359. provider = NotificationProvider(**defaults)
  360. db_session.add(provider)
  361. await db_session.commit()
  362. await db_session.refresh(provider)
  363. return provider
  364. return _create_provider
  365. @pytest.fixture
  366. def archive_factory(db_session):
  367. """Factory to create test archives."""
  368. async def _create_archive(printer_id: int, **kwargs):
  369. from backend.app.models.archive import PrintArchive
  370. defaults = {
  371. "printer_id": printer_id,
  372. "filename": "test_print.gcode.3mf",
  373. "print_name": "Test Print",
  374. "file_path": "archives/test/test_print.gcode.3mf",
  375. "file_size": 1024000,
  376. "status": "completed",
  377. "filament_type": "PLA",
  378. "filament_used_grams": 50.0,
  379. "print_time_seconds": 3600,
  380. }
  381. defaults.update(kwargs)
  382. archive = PrintArchive(**defaults)
  383. db_session.add(archive)
  384. await db_session.commit()
  385. await db_session.refresh(archive)
  386. return archive
  387. return _create_archive
  388. # ============================================================================
  389. # Sample Data Fixtures
  390. # ============================================================================
  391. @pytest.fixture
  392. def sample_mqtt_print_start():
  393. """Sample MQTT message for print start."""
  394. return {
  395. "print": {
  396. "command": "project_file",
  397. "param": "/sdcard/test.gcode.3mf",
  398. "subtask_name": "test_print",
  399. "gcode_state": "RUNNING",
  400. "mc_percent": 0,
  401. }
  402. }
  403. @pytest.fixture
  404. def sample_mqtt_print_complete():
  405. """Sample MQTT message for print complete."""
  406. return {
  407. "print": {
  408. "gcode_state": "FINISH",
  409. "mc_percent": 100,
  410. "subtask_name": "test_print",
  411. }
  412. }
  413. @pytest.fixture
  414. def sample_printer_status():
  415. """Sample printer status data."""
  416. return {
  417. "connected": True,
  418. "state": "IDLE",
  419. "progress": 0,
  420. "layer_num": 0,
  421. "total_layers": 0,
  422. "temperatures": {
  423. "nozzle": 25.0,
  424. "bed": 25.0,
  425. "chamber": 25.0,
  426. },
  427. "remaining_time": 0,
  428. "filename": None,
  429. }
  430. # ============================================================================
  431. # Log Capture Fixtures for Error Detection
  432. # ============================================================================
  433. class LogCapture(logging.Handler):
  434. """Handler that captures log records for testing."""
  435. def __init__(self):
  436. super().__init__()
  437. self.records: list[logging.LogRecord] = []
  438. def emit(self, record: logging.LogRecord):
  439. self.records.append(record)
  440. def clear(self):
  441. self.records.clear()
  442. def get_errors(self) -> list[logging.LogRecord]:
  443. """Get all ERROR and CRITICAL level records."""
  444. return [r for r in self.records if r.levelno >= logging.ERROR]
  445. def get_warnings(self) -> list[logging.LogRecord]:
  446. """Get all WARNING level records."""
  447. return [r for r in self.records if r.levelno == logging.WARNING]
  448. def has_errors(self) -> bool:
  449. """Check if any errors were logged."""
  450. return len(self.get_errors()) > 0
  451. def format_errors(self) -> str:
  452. """Format all errors as a string for assertion messages."""
  453. errors = self.get_errors()
  454. if not errors:
  455. return "No errors"
  456. formatter = logging.Formatter("%(name)s - %(levelname)s - %(message)s")
  457. return "\n".join(formatter.format(r) for r in errors)
  458. @pytest.fixture
  459. def capture_logs():
  460. """Fixture that captures log output during a test.
  461. Usage:
  462. def test_something(capture_logs):
  463. # Do something that might log errors
  464. some_function()
  465. # Check no errors were logged
  466. assert not capture_logs.has_errors(), capture_logs.format_errors()
  467. """
  468. handler = LogCapture()
  469. handler.setLevel(logging.DEBUG)
  470. # Attach to root logger to capture all logs
  471. root_logger = logging.getLogger()
  472. root_logger.addHandler(handler)
  473. yield handler
  474. root_logger.removeHandler(handler)
  475. @pytest.fixture
  476. def assert_no_log_errors(capture_logs):
  477. """Fixture that automatically asserts no errors were logged.
  478. Usage:
  479. def test_something(assert_no_log_errors):
  480. # If any ERROR logs occur during this test, it will fail
  481. some_function()
  482. """
  483. yield capture_logs
  484. errors = capture_logs.get_errors()
  485. if errors:
  486. pytest.fail(f"Unexpected log errors:\n{capture_logs.format_errors()}")