conftest.py 19 KB

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