conftest.py 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465
  1. """Shared test fixtures for BamBuddy backend tests."""
  2. import asyncio
  3. import json
  4. import logging
  5. import os
  6. import sys
  7. from collections.abc import AsyncGenerator
  8. from datetime import datetime
  9. from unittest.mock import AsyncMock, MagicMock, patch
  10. import pytest
  11. # IMPORTANT: Set environment variables BEFORE any app imports
  12. # This must happen before settings/config are loaded
  13. os.environ["LOG_TO_FILE"] = "false"
  14. os.environ["DEBUG"] = "false"
  15. from httpx import ASGITransport, AsyncClient # noqa: E402
  16. from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine # noqa: E402
  17. # Ensure settings use our env vars - import and override before database import
  18. from backend.app.core.config import settings # noqa: E402
  19. settings.log_to_file = False
  20. from backend.app.core.database import Base # noqa: E402
  21. # Use in-memory SQLite for tests
  22. TEST_DATABASE_URL = "sqlite+aiosqlite:///:memory:"
  23. @pytest.fixture(scope="session")
  24. def event_loop():
  25. """Create an instance of the default event loop for each test session."""
  26. loop = asyncio.get_event_loop_policy().new_event_loop()
  27. yield loop
  28. loop.close()
  29. @pytest.fixture
  30. async def test_engine():
  31. """Create a test database engine."""
  32. engine = create_async_engine(TEST_DATABASE_URL, echo=False)
  33. # Import all models to register them
  34. from backend.app.models import (
  35. ams_history,
  36. api_key,
  37. archive,
  38. external_link,
  39. filament,
  40. kprofile_note,
  41. maintenance,
  42. notification,
  43. notification_template,
  44. print_queue,
  45. printer,
  46. project,
  47. settings,
  48. smart_plug,
  49. )
  50. async with engine.begin() as conn:
  51. await conn.run_sync(Base.metadata.create_all)
  52. yield engine
  53. async with engine.begin() as conn:
  54. await conn.run_sync(Base.metadata.drop_all)
  55. await engine.dispose()
  56. @pytest.fixture
  57. async def db_session(test_engine) -> AsyncGenerator[AsyncSession, None]:
  58. """Create a test database session."""
  59. async_session_maker = async_sessionmaker(test_engine, class_=AsyncSession, expire_on_commit=False)
  60. async with async_session_maker() as session:
  61. yield session
  62. @pytest.fixture
  63. async def async_client(test_engine, db_session) -> AsyncGenerator[AsyncClient, None]:
  64. """Create an async test client."""
  65. from backend.app.core.database import async_session, get_db
  66. from backend.app.main import app
  67. # Create a new session maker for the test engine
  68. test_async_session = async_sessionmaker(test_engine, class_=AsyncSession, expire_on_commit=False)
  69. async def override_get_db():
  70. async with test_async_session() as session:
  71. yield session
  72. app.dependency_overrides[get_db] = override_get_db
  73. # Also patch the module-level async_session used by services
  74. with patch("backend.app.core.database.async_session", test_async_session):
  75. async with AsyncClient(transport=ASGITransport(app=app), base_url="http://test") as client:
  76. yield client
  77. app.dependency_overrides.clear()
  78. # ============================================================================
  79. # Mock External Services
  80. # ============================================================================
  81. @pytest.fixture
  82. def mock_tasmota_service():
  83. """Mock the Tasmota service for smart plug tests."""
  84. # Patch both the module where it's defined and where it's imported
  85. with (
  86. patch("backend.app.services.tasmota.tasmota_service") as mock,
  87. patch("backend.app.api.routes.smart_plugs.tasmota_service") as mock2,
  88. ):
  89. mock.turn_on = AsyncMock(return_value=True)
  90. mock.turn_off = AsyncMock(return_value=True)
  91. mock.toggle = AsyncMock(return_value=True)
  92. mock.get_status = AsyncMock(return_value={"state": "ON", "reachable": True, "device_name": "Test Plug"})
  93. mock.get_energy = AsyncMock(
  94. return_value={
  95. "power": 150.5,
  96. "voltage": 120.0,
  97. "current": 1.25,
  98. "today": 2.5,
  99. "total": 100.0,
  100. "factor": 0.95,
  101. }
  102. )
  103. mock.test_connection = AsyncMock(return_value={"success": True, "state": "ON", "device_name": "Test Plug"})
  104. # Copy mocks to second patch target
  105. mock2.turn_on = mock.turn_on
  106. mock2.turn_off = mock.turn_off
  107. mock2.toggle = mock.toggle
  108. mock2.get_status = mock.get_status
  109. mock2.get_energy = mock.get_energy
  110. mock2.test_connection = mock.test_connection
  111. yield mock
  112. @pytest.fixture
  113. def mock_mqtt_client():
  114. """Mock the MQTT client for printer communication tests."""
  115. with patch("backend.app.services.bambu_mqtt.BambuMQTTClient") as mock:
  116. instance = MagicMock()
  117. instance.state = MagicMock(connected=True, state="IDLE", progress=0, temperatures={"nozzle": 25, "bed": 25})
  118. instance.connect = MagicMock()
  119. instance.disconnect = MagicMock()
  120. mock.return_value = instance
  121. yield mock
  122. @pytest.fixture
  123. def mock_ftp_client():
  124. """Mock the FTP client for file transfer tests."""
  125. with (
  126. patch("backend.app.services.bambu_ftp.download_file_async") as download_mock,
  127. patch("backend.app.services.bambu_ftp.list_files_async") as list_mock,
  128. ):
  129. download_mock.return_value = True
  130. list_mock.return_value = []
  131. yield {"download": download_mock, "list": list_mock}
  132. @pytest.fixture
  133. def mock_httpx_client():
  134. """Mock httpx for webhook/notification HTTP calls."""
  135. with patch("httpx.AsyncClient") as mock_class:
  136. mock_instance = AsyncMock()
  137. mock_response = MagicMock()
  138. mock_response.status_code = 200
  139. mock_response.text = "OK"
  140. mock_response.json.return_value = {}
  141. mock_instance.get = AsyncMock(return_value=mock_response)
  142. mock_instance.post = AsyncMock(return_value=mock_response)
  143. mock_instance.__aenter__ = AsyncMock(return_value=mock_instance)
  144. mock_instance.__aexit__ = AsyncMock()
  145. mock_class.return_value = mock_instance
  146. yield mock_instance
  147. @pytest.fixture
  148. def mock_printer_manager():
  149. """Mock the printer manager for status checks."""
  150. with patch("backend.app.services.printer_manager.printer_manager") as mock:
  151. mock.get_status = MagicMock(
  152. return_value=MagicMock(
  153. connected=True,
  154. state="IDLE",
  155. progress=0,
  156. temperatures={"nozzle": 25, "bed": 25, "chamber": 25},
  157. raw_data={},
  158. )
  159. )
  160. mock.mark_printer_offline = MagicMock()
  161. yield mock
  162. # ============================================================================
  163. # Factory Fixtures for Test Data
  164. # ============================================================================
  165. @pytest.fixture
  166. def smart_plug_factory(db_session):
  167. """Factory to create test smart plugs."""
  168. async def _create_plug(**kwargs):
  169. from backend.app.models.smart_plug import SmartPlug
  170. defaults = {
  171. "name": "Test Plug",
  172. "ip_address": "192.168.1.100",
  173. "enabled": True,
  174. "auto_on": True,
  175. "auto_off": True,
  176. "off_delay_mode": "time",
  177. "off_delay_minutes": 5,
  178. "off_temp_threshold": 70,
  179. "schedule_enabled": False,
  180. "power_alert_enabled": False,
  181. }
  182. defaults.update(kwargs)
  183. plug = SmartPlug(**defaults)
  184. db_session.add(plug)
  185. await db_session.commit()
  186. await db_session.refresh(plug)
  187. return plug
  188. return _create_plug
  189. @pytest.fixture
  190. def printer_factory(db_session):
  191. """Factory to create test printers."""
  192. _counter = [0] # Use list to allow mutation in nested function
  193. async def _create_printer(**kwargs):
  194. from backend.app.models.printer import Printer
  195. _counter[0] += 1
  196. counter = _counter[0]
  197. defaults = {
  198. "name": "Test Printer",
  199. "serial_number": f"00M09A{counter:09d}", # Unique serial per printer
  200. "ip_address": f"192.168.1.{100 + counter}", # Unique IP per printer
  201. "access_code": "12345678",
  202. "is_active": True,
  203. "auto_archive": True,
  204. "model": "X1C",
  205. }
  206. defaults.update(kwargs)
  207. printer = Printer(**defaults)
  208. db_session.add(printer)
  209. await db_session.commit()
  210. await db_session.refresh(printer)
  211. return printer
  212. return _create_printer
  213. @pytest.fixture
  214. def notification_provider_factory(db_session):
  215. """Factory to create test notification providers."""
  216. async def _create_provider(**kwargs):
  217. from backend.app.models.notification import NotificationProvider
  218. config = kwargs.pop("config", {"server": "https://ntfy.sh", "topic": "test-topic"})
  219. if isinstance(config, dict):
  220. config = json.dumps(config)
  221. defaults = {
  222. "name": "Test Provider",
  223. "provider_type": "ntfy",
  224. "enabled": True,
  225. "config": config,
  226. "on_print_start": True,
  227. "on_print_complete": True,
  228. "on_print_failed": True,
  229. "on_print_stopped": True,
  230. "on_print_progress": False,
  231. "on_printer_offline": False,
  232. "on_printer_error": False,
  233. "on_filament_low": False,
  234. "on_maintenance_due": False,
  235. "on_ams_humidity_high": False,
  236. "on_ams_temperature_high": False,
  237. "quiet_hours_enabled": False,
  238. "daily_digest_enabled": False,
  239. }
  240. defaults.update(kwargs)
  241. provider = NotificationProvider(**defaults)
  242. db_session.add(provider)
  243. await db_session.commit()
  244. await db_session.refresh(provider)
  245. return provider
  246. return _create_provider
  247. @pytest.fixture
  248. def archive_factory(db_session):
  249. """Factory to create test archives."""
  250. async def _create_archive(printer_id: int, **kwargs):
  251. from backend.app.models.archive import PrintArchive
  252. defaults = {
  253. "printer_id": printer_id,
  254. "filename": "test_print.gcode.3mf",
  255. "print_name": "Test Print",
  256. "file_path": "archives/test/test_print.gcode.3mf",
  257. "file_size": 1024000,
  258. "status": "completed",
  259. "filament_type": "PLA",
  260. "filament_used_grams": 50.0,
  261. "print_time_seconds": 3600,
  262. }
  263. defaults.update(kwargs)
  264. archive = PrintArchive(**defaults)
  265. db_session.add(archive)
  266. await db_session.commit()
  267. await db_session.refresh(archive)
  268. return archive
  269. return _create_archive
  270. # ============================================================================
  271. # Sample Data Fixtures
  272. # ============================================================================
  273. @pytest.fixture
  274. def sample_mqtt_print_start():
  275. """Sample MQTT message for print start."""
  276. return {
  277. "print": {
  278. "command": "project_file",
  279. "param": "/sdcard/test.gcode.3mf",
  280. "subtask_name": "test_print",
  281. "gcode_state": "RUNNING",
  282. "mc_percent": 0,
  283. }
  284. }
  285. @pytest.fixture
  286. def sample_mqtt_print_complete():
  287. """Sample MQTT message for print complete."""
  288. return {
  289. "print": {
  290. "gcode_state": "FINISH",
  291. "mc_percent": 100,
  292. "subtask_name": "test_print",
  293. }
  294. }
  295. @pytest.fixture
  296. def sample_printer_status():
  297. """Sample printer status data."""
  298. return {
  299. "connected": True,
  300. "state": "IDLE",
  301. "progress": 0,
  302. "layer_num": 0,
  303. "total_layers": 0,
  304. "temperatures": {
  305. "nozzle": 25.0,
  306. "bed": 25.0,
  307. "chamber": 25.0,
  308. },
  309. "remaining_time": 0,
  310. "filename": None,
  311. }
  312. # ============================================================================
  313. # Log Capture Fixtures for Error Detection
  314. # ============================================================================
  315. class LogCapture(logging.Handler):
  316. """Handler that captures log records for testing."""
  317. def __init__(self):
  318. super().__init__()
  319. self.records: list[logging.LogRecord] = []
  320. def emit(self, record: logging.LogRecord):
  321. self.records.append(record)
  322. def clear(self):
  323. self.records.clear()
  324. def get_errors(self) -> list[logging.LogRecord]:
  325. """Get all ERROR and CRITICAL level records."""
  326. return [r for r in self.records if r.levelno >= logging.ERROR]
  327. def get_warnings(self) -> list[logging.LogRecord]:
  328. """Get all WARNING level records."""
  329. return [r for r in self.records if r.levelno == logging.WARNING]
  330. def has_errors(self) -> bool:
  331. """Check if any errors were logged."""
  332. return len(self.get_errors()) > 0
  333. def format_errors(self) -> str:
  334. """Format all errors as a string for assertion messages."""
  335. errors = self.get_errors()
  336. if not errors:
  337. return "No errors"
  338. formatter = logging.Formatter("%(name)s - %(levelname)s - %(message)s")
  339. return "\n".join(formatter.format(r) for r in errors)
  340. @pytest.fixture
  341. def capture_logs():
  342. """Fixture that captures log output during a test.
  343. Usage:
  344. def test_something(capture_logs):
  345. # Do something that might log errors
  346. some_function()
  347. # Check no errors were logged
  348. assert not capture_logs.has_errors(), capture_logs.format_errors()
  349. """
  350. handler = LogCapture()
  351. handler.setLevel(logging.DEBUG)
  352. # Attach to root logger to capture all logs
  353. root_logger = logging.getLogger()
  354. root_logger.addHandler(handler)
  355. yield handler
  356. root_logger.removeHandler(handler)
  357. @pytest.fixture
  358. def assert_no_log_errors(capture_logs):
  359. """Fixture that automatically asserts no errors were logged.
  360. Usage:
  361. def test_something(assert_no_log_errors):
  362. # If any ERROR logs occur during this test, it will fail
  363. some_function()
  364. """
  365. yield capture_logs
  366. errors = capture_logs.get_errors()
  367. if errors:
  368. pytest.fail(f"Unexpected log errors:\n{capture_logs.format_errors()}")