Coverage for tests / unit / tools / assertions / conftest.py: 48%

1"""Assertion helper fixtures for tool definition testing. 

2 

3These fixtures provide reusable assertion helpers for testing 

4tool plugin definitions across multiple tools. 

5""" 

6 

7from __future__ import annotations 

8 

9from collections.abc import Callable 

10from typing import Any 

11 

12import pytest 

13from assertpy import assert_that 

14 

15 

16@pytest.fixture 

17def assert_definition_has_name() -> Callable[[Any, str], None]: 

18 """Helper to assert a definition has the expected name. 

19 

20 Returns: 

21 A callable that asserts definition.name equals expected value. 

22 

23 Example: 

24 def test_definition_name(plugin, assert_definition_has_name): 

25 assert_definition_has_name(plugin.definition, "ruff") 

26 """ 

27 

28 def _assert(definition: Any, expected_name: str) -> None: 

29 assert_that(definition.name).is_equal_to(expected_name) 

30 

31 return _assert 

32 

33 

34@pytest.fixture 

35def assert_definition_has_description() -> Callable[[Any], None]: 

36 """Helper to assert a definition has a non-empty description. 

37 

38 Returns: 

39 A callable that asserts definition.description is not empty. 

40 

41 Example: 

42 def test_definition_description(plugin, assert_definition_has_description): 

43 assert_definition_has_description(plugin.definition) 

44 """ 

45 

46 def _assert(definition: Any) -> None: 

47 assert_that(definition.description).is_not_empty() 

48 

49 return _assert 

50 

51 

52@pytest.fixture 

53def assert_definition_file_patterns() -> Callable[[Any, list[str]], None]: 

54 """Helper to assert a definition has expected file patterns. 

55 

56 Returns: 

57 A callable that asserts definition.file_patterns contains expected patterns. 

58 

59 Example: 

60 def test_definition_patterns(plugin, assert_definition_file_patterns): 

61 assert_definition_file_patterns(plugin.definition, ["*.py"]) 

62 """ 

63 

64 def _assert(definition: Any, expected_patterns: list[str]) -> None: 

65 for pattern in expected_patterns: 

66 assert_that(definition.file_patterns).contains(pattern) 

67 

68 return _assert 

69 

70 

71@pytest.fixture 

72def assert_definition_can_fix() -> Callable[[Any, bool], None]: 

73 """Helper to assert a definition's can_fix value. 

74 

75 Returns: 

76 A callable that asserts definition.can_fix equals expected value. 

77 

78 Example: 

79 def test_definition_can_fix(plugin, assert_definition_can_fix): 

80 assert_definition_can_fix(plugin.definition, True) 

81 """ 

82 

83 def _assert(definition: Any, expected_can_fix: bool) -> None: 

84 assert_that(definition.can_fix).is_equal_to(expected_can_fix) 

85 

86 return _assert 

87 

88 

89@pytest.fixture 

90def assert_definition_timeout() -> Callable[[Any, int], None]: 

91 """Helper to assert a definition's default timeout. 

92 

93 Returns: 

94 A callable that asserts definition.default_timeout equals expected value. 

95 

96 Example: 

97 def test_definition_timeout(plugin, assert_definition_timeout): 

98 assert_definition_timeout(plugin.definition, 30) 

99 """ 

100 

101 def _assert(definition: Any, expected_timeout: int) -> None: 

102 assert_that(definition.default_timeout).is_equal_to(expected_timeout) 

103 

104 return _assert