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 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
|
"""Tests for the client."""
from __future__ import annotations
import asyncio
from typing import TYPE_CHECKING, Any, Callable
import aiohttp
from aiohttp import ClientError
from aiohttp.hdrs import METH_PUT
from aioresponses import CallbackResult, aioresponses
import pytest
from airgradient import (
AirGradientClient,
AirGradientConnectionError,
AirGradientError,
AirGradientParseError,
ConfigurationControl,
LedBarMode,
PmStandard,
TemperatureUnit,
)
from tests import load_fixture
from tests.const import HEADERS, MOCK_HOST, MOCK_URL
if TYPE_CHECKING:
from collections.abc import Awaitable
from syrupy import SnapshotAssertion
async def test_putting_in_own_session(
responses: aioresponses,
) -> None:
"""Test putting in own session."""
responses.get(
f"{MOCK_URL}/measures/current",
status=200,
body=load_fixture("current_measures.json"),
)
async with aiohttp.ClientSession() as session:
airgradient = AirGradientClient(session=session, host=MOCK_HOST)
await airgradient.get_current_measures()
assert airgradient.session is not None
assert not airgradient.session.closed
await airgradient.close()
assert not airgradient.session.closed
async def test_creating_own_session(
responses: aioresponses,
) -> None:
"""Test creating own session."""
responses.get(
f"{MOCK_URL}/measures/current",
status=200,
body=load_fixture("current_measures.json"),
)
airgradient = AirGradientClient(host=MOCK_HOST)
await airgradient.get_current_measures()
assert airgradient.session is not None
assert not airgradient.session.closed
await airgradient.close()
assert airgradient.session.closed
async def test_unexpected_server_response(
responses: aioresponses,
client: AirGradientClient,
) -> None:
"""Test handling unexpected response."""
responses.get(
f"{MOCK_URL}/measures/current",
status=404,
headers={"Content-Type": "plain/text"},
body="Yes",
)
with pytest.raises(AirGradientError):
await client.get_current_measures()
async def test_unexpected_server_json_response(
client: AirGradientClient,
responses: aioresponses,
) -> None:
"""Test handling unexpected response missing required fields."""
async def response_handler(_: str, **_kwargs: Any) -> CallbackResult:
"""Response handler for this test."""
return CallbackResult(payload={})
responses.get(
f"{MOCK_URL}/measures/current",
callback=response_handler,
)
with pytest.raises(AirGradientParseError):
await client.get_current_measures()
responses.get(
f"{MOCK_URL}/config",
callback=response_handler,
)
with pytest.raises(AirGradientParseError):
await client.get_config()
async def test_timeout(
responses: aioresponses,
) -> None:
"""Test request timeout."""
# Faking a timeout by sleeping
async def response_handler(_: str, **_kwargs: Any) -> CallbackResult:
"""Response handler for this test."""
await asyncio.sleep(2)
return CallbackResult(body="Goodmorning!")
responses.get(
f"{MOCK_URL}/measures/current",
callback=response_handler,
)
async with AirGradientClient(request_timeout=1, host=MOCK_HOST) as airgradient:
with pytest.raises(AirGradientConnectionError):
await airgradient.get_current_measures()
async def test_client_error(
client: AirGradientClient,
responses: aioresponses,
) -> None:
"""Test client error."""
async def response_handler(_: str, **_kwargs: Any) -> CallbackResult:
"""Response handler for this test."""
raise ClientError
responses.get(
f"{MOCK_URL}/measures/current",
callback=response_handler,
)
with pytest.raises(AirGradientConnectionError):
await client.get_current_measures()
@pytest.mark.parametrize(
"fixture",
[
"current_measures.json",
"current_measures_2.json",
"measures_after_boot.json",
"current_measures_zero.json",
],
)
async def test_current_fixtures(
responses: aioresponses,
client: AirGradientClient,
snapshot: SnapshotAssertion,
fixture: str,
) -> None:
"""Test status call."""
responses.get(
f"{MOCK_URL}/measures/current",
status=200,
body=load_fixture(fixture),
)
assert await client.get_current_measures() == snapshot
async def test_config(
responses: aioresponses,
client: AirGradientClient,
snapshot: SnapshotAssertion,
) -> None:
"""Test config call."""
responses.get(
f"{MOCK_URL}/config",
status=200,
body=load_fixture("config.json"),
)
assert await client.get_config() == snapshot
@pytest.mark.parametrize(
("function", "expected_data"),
[
(
lambda client: client.set_temperature_unit(TemperatureUnit.CELSIUS),
{"temperatureUnit": "c"},
),
(
lambda client: client.set_pm_standard(PmStandard.UGM3),
{"pmStandard": "ugm3"},
),
(
lambda client: client.set_configuration_control(ConfigurationControl.CLOUD),
{"configurationControl": "cloud"},
),
(
lambda client: client.set_led_bar_mode(LedBarMode.CO2),
{"ledBarMode": "co2"},
),
(
lambda client: client.request_co2_calibration(),
{"co2CalibrationRequested": True},
),
(
lambda client: client.request_led_bar_test(),
{"ledBarTestRequested": True},
),
(
lambda client: client.set_display_brightness(50),
{"displayBrightness": 50},
),
(
lambda client: client.set_led_bar_brightness(50),
{"ledBarBrightness": 50},
),
(
lambda client: client.enable_sharing_data(enable=True),
{"postDataToAirGradient": True},
),
(
lambda client: client.set_co2_automatic_baseline_calibration(50),
{"abcDays": 50},
),
(
lambda client: client.set_nox_learning_offset(50),
{"noxLearningOffset": 50},
),
(
lambda client: client.set_tvoc_learning_offset(50),
{"tvocLearningOffset": 50},
),
],
)
async def test_setting_config(
responses: aioresponses,
client: AirGradientClient,
function: Callable[[AirGradientClient], Awaitable[None]],
expected_data: dict[str, Any],
) -> None:
"""Test config call."""
responses.put(
f"{MOCK_URL}/config",
status=200,
body="Success",
headers={"Content-Type": "plain/text"},
)
await function(client)
responses.assert_called_once_with(
f"{MOCK_URL}/config",
METH_PUT,
headers=HEADERS,
json=expected_data,
)
async def test_latest_version(
responses: aioresponses, client: AirGradientClient, snapshot: SnapshotAssertion
) -> None:
"""Test getting latest firmware version."""
responses.get(
"http://hw.airgradient.com/sensors/airgradient:84fce612f5b8/generic/os/firmware",
status=200,
body=load_fixture("version.json"),
)
assert snapshot == await client.get_latest_firmware_version("84fce612f5b8")
responses.assert_called_with(
"http://hw.airgradient.com/sensors/airgradient:84fce612f5b8/generic/os/firmware",
headers=HEADERS,
json=None,
)
async def test_version_parse_error(
responses: aioresponses,
client: AirGradientClient,
) -> None:
"""Test version parse error."""
responses.get(
"http://hw.airgradient.com/sensors/airgradient:84fce612f5b8/generic/os/firmware",
status=200,
body="{}",
)
with pytest.raises(AirGradientParseError):
await client.get_latest_firmware_version("84fce612f5b8")
|