conftest.py 19 KB

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