File: test_entity_info_ha.py

package info (click to toggle)
python-bsblan 4.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,196 kB
  • sloc: python: 6,864; makefile: 3
file content (220 lines) | stat: -rw-r--r-- 6,252 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
"""Tests for EntityInfo HA integration properties (device class, state class)."""

import pytest

from bsblan.models import DataType, EntityInfo

# -- suggested_device_class ------------------------------------------------


@pytest.mark.parametrize(
    ("unit", "expected"),
    [
        ("°C", "temperature"),
        ("°F", "temperature"),
        ("°C", "temperature"),
        ("°F", "temperature"),
        ("°C", "temperature"),
        ("°F", "temperature"),
        ("kWh", "energy"),
        ("Wh", "energy"),
        ("MWh", "energy"),
        ("kW", "power"),
        ("W", "power"),
        ("bar", "pressure"),
        ("Pa", "pressure"),
        ("hPa", "pressure"),
        ("V", "voltage"),
        ("A", "current"),
        ("mA", "current"),
        ("Hz", "frequency"),
        ("l/min", "volume_flow_rate"),
        ("l/h", "volume_flow_rate"),
        ("h", "duration"),
        ("min", "duration"),
        ("s", "duration"),
        ("%", "power_factor"),
    ],
)
def test_suggested_device_class(unit: str, expected: str) -> None:
    """Test suggested_device_class maps unit to correct HA device class."""
    entity = EntityInfo(
        name="Test",
        value="42",
        unit=unit,
        desc="",
        data_type=DataType.PLAIN_NUMBER,
    )
    assert entity.suggested_device_class == expected


@pytest.mark.parametrize(
    ("unit", "data_type"),
    [
        ("", DataType.ENUM),
        ("bbl", DataType.PLAIN_NUMBER),
        ("unknown", DataType.PLAIN_NUMBER),
        ("°C", DataType.ENUM),
        ("kWh", DataType.ENUM),
        ("°C", DataType.TIME),
        ("°C", DataType.WEEKDAY),
        ("°C", DataType.STRING),
    ],
)
def test_suggested_device_class_none(unit: str, data_type: int) -> None:
    """Test suggested_device_class returns None for unmapped or non-numeric types."""
    entity = EntityInfo(
        name="Test",
        value="42",
        unit=unit,
        desc="",
        data_type=data_type,
    )
    assert entity.suggested_device_class is None


# -- suggested_state_class -------------------------------------------------


@pytest.mark.parametrize(
    ("unit", "expected"),
    [
        ("kWh", "total_increasing"),
        ("MWh", "total_increasing"),
        ("Wh", "total_increasing"),
        ("°C", "measurement"),
        ("°F", "measurement"),
        ("°C", "measurement"),
        ("°C", "measurement"),
        ("kW", "measurement"),
        ("W", "measurement"),
        ("bar", "measurement"),
        ("Pa", "measurement"),
        ("V", "measurement"),
        ("A", "measurement"),
        ("Hz", "measurement"),
        ("l/min", "measurement"),
        ("%", "measurement"),
        ("h", "measurement"),
        ("min", "measurement"),
        ("s", "measurement"),
    ],
)
def test_suggested_state_class(unit: str, expected: str) -> None:
    """Test suggested_state_class maps unit to correct HA state class."""
    entity = EntityInfo(
        name="Test",
        value="42",
        unit=unit,
        desc="",
        data_type=DataType.PLAIN_NUMBER,
    )
    assert entity.suggested_state_class == expected


@pytest.mark.parametrize(
    ("unit", "data_type"),
    [
        ("", DataType.ENUM),
        ("bbl", DataType.PLAIN_NUMBER),
        ("kWh", DataType.ENUM),
        ("°C", DataType.TIME),
        ("°C", DataType.WEEKDAY),
        ("°C", DataType.STRING),
    ],
)
def test_suggested_state_class_none(unit: str, data_type: int) -> None:
    """Test suggested_state_class returns None for unmapped or non-numeric types."""
    entity = EntityInfo(
        name="Test",
        value="42",
        unit=unit,
        desc="",
        data_type=data_type,
    )
    assert entity.suggested_state_class is None


# -- dataType_name / dataType_family fields --------------------------------


def test_data_type_name_and_family_default() -> None:
    """Test data_type_name and data_type_family default to empty string."""
    entity = EntityInfo(
        name="Test",
        value="42",
        unit="kWh",
        desc="",
        data_type=DataType.PLAIN_NUMBER,
    )
    assert entity.data_type_name == ""
    assert entity.data_type_family == ""


@pytest.mark.parametrize(
    ("type_name", "type_family"),
    [
        ("TEMP", "VALS"),
        ("ENUM", "ENUM"),
    ],
)
def test_data_type_name_from_json(type_name: str, type_family: str) -> None:
    """Test data_type_name/family populated from JSON response."""
    entity = EntityInfo.from_dict(
        {
            "name": "Test",
            "dataType_name": type_name,
            "dataType_family": type_family,
            "error": 0,
            "value": "18.0",
            "desc": "",
            "dataType": 0,
            "readonly": 0,
            "unit": "°C",
        }
    )
    assert entity.data_type_name == type_name
    assert entity.data_type_family == type_family


# -- Backwards compatibility -----------------------------------------------


def test_backwards_compat_no_data_type_name_in_json() -> None:
    """Test EntityInfo works when JSON has no dataType_name/family."""
    entity = EntityInfo.from_dict(
        {
            "name": "Outside temp",
            "error": 0,
            "value": "7.6",
            "desc": "",
            "dataType": 0,
            "readonly": 0,
            "unit": "°C",
        }
    )
    assert entity.data_type_name == ""
    assert entity.data_type_family == ""
    assert entity.suggested_device_class == "temperature"
    assert entity.suggested_state_class == "measurement"


def test_backwards_compat_existing_fields_unchanged() -> None:
    """Test that existing fields still work identically."""
    entity = EntityInfo(
        name="Test Temp",
        value="22.5",
        unit="°C",
        desc="",
        data_type=DataType.PLAIN_NUMBER,
    )
    # Existing behavior: value converted to float for temperature
    assert entity.value == 22.5
    assert entity.name == "Test Temp"
    assert entity.unit == "°C"
    assert entity.data_type == DataType.PLAIN_NUMBER
    assert entity.error == 0
    assert entity.readonly == 0
    assert entity.readwrite == 0
    assert entity.precision is None
    assert entity.enum_description is None