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 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
|
"""Tests for MyBMWAccount."""
import datetime
import logging
from pathlib import Path
from unittest import mock
import httpx
import pytest
import respx
from bimmer_connected.account import MyBMWAccount
from bimmer_connected.api.authentication import MyBMWAuthentication, MyBMWLoginRetry
from bimmer_connected.api.client import MyBMWClient
from bimmer_connected.api.regions import get_region_from_name
from bimmer_connected.const import ATTR_CAPABILITIES, VEHICLES_URL, CarBrands
from bimmer_connected.models import GPSPosition, MyBMWAPIError, MyBMWAuthError, MyBMWQuotaError
from . import (
RESPONSE_DIR,
TEST_PASSWORD,
TEST_REGION,
TEST_REGION_STRING,
TEST_USERNAME,
VIN_G26,
VIN_I20,
get_fingerprint_count,
load_response,
)
from .common import MyBMWMockRouter
from .conftest import prepare_account_with_vehicles
@pytest.mark.asyncio
async def test_login_row_na(bmw_fixture: respx.Router):
"""Test the login flow."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name(TEST_REGION_STRING))
await account.get_vehicles()
assert account is not None
@pytest.mark.asyncio
async def test_login_refresh_token_row_na_expired(bmw_fixture: respx.Router):
"""Test the login flow using refresh_token."""
with mock.patch("bimmer_connected.api.authentication.EXPIRES_AT_OFFSET", datetime.timedelta(seconds=30000)):
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name(TEST_REGION_STRING))
await account.get_vehicles()
with mock.patch(
"bimmer_connected.api.authentication.MyBMWAuthentication._refresh_token_row_na",
wraps=account.config.authentication._refresh_token_row_na,
) as mock_listener:
mock_listener.reset_mock()
await account.get_vehicles()
# Should not be called at all, as expiry date is not checked anymore
assert mock_listener.call_count == 0
assert account.config.authentication.refresh_token is not None
@pytest.mark.asyncio
async def test_login_refresh_token_row_na_401(bmw_fixture: respx.Router):
"""Test the login flow using refresh_token."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name(TEST_REGION_STRING))
await account.get_vehicles()
with mock.patch(
"bimmer_connected.api.authentication.MyBMWAuthentication._refresh_token_row_na",
wraps=account.config.authentication._refresh_token_row_na,
) as mock_listener:
bmw_fixture.get("/eadrax-vcs/v4/vehicles/state").mock(
side_effect=[httpx.Response(401), *([httpx.Response(200, json={ATTR_CAPABILITIES: {}})] * 10)]
)
mock_listener.reset_mock()
await account.get_vehicles()
assert mock_listener.call_count == 1
assert account.config.authentication.refresh_token is not None
@pytest.mark.asyncio
async def test_login_refresh_token_row_na_invalid(caplog, bmw_fixture: respx.Router):
"""Test the login flow using refresh_token."""
bmw_fixture.post("/gcdm/oauth/token").mock(
side_effect=[
httpx.Response(400),
httpx.Response(200, json=load_response(RESPONSE_DIR / "auth" / "auth_token.json")),
]
)
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name(TEST_REGION_STRING))
account.set_refresh_token("INVALID")
caplog.set_level(logging.DEBUG)
await account.get_vehicles()
debug_messages = [r.message for r in caplog.records if r.name.startswith("bimmer_connected")]
assert "Authenticating with refresh token for North America & Rest of World." in debug_messages
assert "Unable to get access token using refresh token, falling back to username/password." in debug_messages
assert "Authenticating with MyBMW flow for North America & Rest of World." in debug_messages
@pytest.mark.asyncio
async def test_login_china(bmw_fixture: respx.Router):
"""Test the login flow for region `china`."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name("china"))
await account.get_vehicles()
assert account is not None
@pytest.mark.asyncio
async def test_login_refresh_token_china_expired(bmw_fixture: respx.Router):
"""Test the login flow using refresh_token for region `china`."""
with mock.patch("bimmer_connected.api.authentication.EXPIRES_AT_OFFSET", datetime.timedelta(seconds=30000)):
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name("china"))
await account.get_vehicles()
with mock.patch(
"bimmer_connected.api.authentication.MyBMWAuthentication._refresh_token_china",
wraps=account.config.authentication._refresh_token_china,
) as mock_listener:
mock_listener.reset_mock()
await account.get_vehicles()
# Should not be called at all, as expiry date is not checked anymore
assert mock_listener.call_count == 0
assert account.config.authentication.refresh_token is not None
@pytest.mark.asyncio
async def test_login_refresh_token_china_401(bmw_fixture: respx.Router):
"""Test the login flow using refresh_token."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name("china"))
await account.get_vehicles()
with mock.patch(
"bimmer_connected.api.authentication.MyBMWAuthentication._refresh_token_china",
wraps=account.config.authentication._refresh_token_china,
) as mock_listener:
bmw_fixture.get("/eadrax-vcs/v4/vehicles/state").mock(
side_effect=[httpx.Response(401), *([httpx.Response(200, json={ATTR_CAPABILITIES: {}})] * 10)]
)
mock_listener.reset_mock()
await account.get_vehicles()
assert mock_listener.call_count == 1
assert account.config.authentication.refresh_token is not None
@pytest.mark.asyncio
async def test_login_refresh_token_china_invalid(caplog, bmw_fixture: respx.Router):
"""Test the login flow using refresh_token."""
bmw_fixture.post("/eadrax-coas/v2/oauth/token").mock(
side_effect=[
httpx.Response(400),
httpx.Response(200, json=load_response(RESPONSE_DIR / "auth" / "auth_token.json")),
]
)
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name("china"))
account.set_refresh_token("INVALID")
caplog.set_level(logging.DEBUG)
await account.get_vehicles()
debug_messages = [r.message for r in caplog.records if r.name.startswith("bimmer_connected")]
assert "Authenticating with refresh token for China." in debug_messages
assert "Unable to get access token using refresh token, falling back to username/password." in debug_messages
assert "Authenticating with MyBMW flow for China." in debug_messages
@pytest.mark.asyncio
async def test_vehicles(bmw_fixture: respx.Router):
"""Test the login flow."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name("china"))
await account.get_vehicles()
assert account.config.authentication.access_token is not None
assert get_fingerprint_count("profiles") == len(account.vehicles)
vehicle = account.get_vehicle(VIN_G26)
assert vehicle is not None
assert vehicle.vin == VIN_G26
assert account.get_vehicle("invalid_vin") is None
@pytest.mark.asyncio
async def test_vehicle_init(bmw_fixture: respx.Router):
"""Test vehicle initialization."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
with mock.patch(
"bimmer_connected.account.MyBMWAccount._init_vehicles",
wraps=account._init_vehicles,
) as mock_listener:
mock_listener.reset_mock()
# First call on init
await account.get_vehicles()
assert len(account.vehicles) == get_fingerprint_count("profiles")
# No call to _init_vehicles()
await account.get_vehicles()
assert len(account.vehicles) == get_fingerprint_count("profiles")
# Second, forced call _init_vehicles()
await account.get_vehicles(force_init=True)
assert len(account.vehicles) == get_fingerprint_count("profiles")
assert mock_listener.call_count == 2
@pytest.mark.asyncio
async def test_invalid_password(bmw_fixture: respx.Router):
"""Test parsing the results of an invalid password."""
bmw_fixture.post("/gcdm/oauth/authenticate").respond(
401, json=load_response(RESPONSE_DIR / "auth" / "auth_error_wrong_password.json")
)
with pytest.raises(MyBMWAuthError):
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
await account.get_vehicles()
@pytest.mark.asyncio
async def test_invalid_password_china(bmw_fixture: respx.Router):
"""Test parsing the results of an invalid password."""
bmw_fixture.post("/eadrax-coas/v2/login/pwd").respond(
422, json=load_response(RESPONSE_DIR / "auth" / "auth_cn_login_error.json")
)
with pytest.raises(MyBMWAPIError):
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name("china"))
await account.get_vehicles()
@pytest.mark.asyncio
async def test_server_error(bmw_fixture: respx.Router):
"""Test parsing the results of a server error."""
bmw_fixture.post("/gcdm/oauth/authenticate").respond(
500, text=load_response(RESPONSE_DIR / "auth" / "auth_error_internal_error.txt")
)
with pytest.raises(MyBMWAPIError):
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
await account.get_vehicles()
@pytest.mark.asyncio
async def test_vehicle_search_case(bmw_fixture: respx.Router):
"""Check if the search for the vehicle by VIN is NOT case sensitive."""
account = await prepare_account_with_vehicles()
vin = account.vehicles[1].vin
assert vin == account.get_vehicle(vin).vin
assert vin == account.get_vehicle(vin.lower()).vin
assert vin == account.get_vehicle(vin.upper()).vin
@pytest.mark.asyncio
async def test_get_fingerprints(monkeypatch: pytest.MonkeyPatch, bmw_fixture: respx.Router, bmw_log_all_responses):
"""Test getting fingerprints."""
# Prepare Number of good responses (vehicle profiles + vehicle states, charging settings per vehicle)
# and 2x vehicle list
json_count = (
get_fingerprint_count("vehicles")
+ get_fingerprint_count("profiles")
+ get_fingerprint_count("states")
+ get_fingerprint_count("charging_settings")
)
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION, log_responses=True)
await account.get_vehicles()
# This should have been successful
filenames = [Path(f.filename) for f in account.get_stored_responses()]
json_files = [f for f in filenames if f.suffix == ".json"]
txt_files = [f for f in filenames if f.suffix == ".txt"]
assert len(json_files) == json_count # all good
assert len(txt_files) == 0 # no errors
# Now we simulate an error for a single vehicle
# We need to remove the existing state route first and add it back later as otherwise our error call is never
# matched (respx matches by order of routes and we don't replace the existing one)
state_route = bmw_fixture.routes.pop("state")
bmw_fixture.get("/eadrax-vcs/v4/vehicles/state", headers={"bmw-vin": VIN_G26}).respond(
500, text=load_response(RESPONSE_DIR / "auth" / "auth_error_internal_error.txt")
)
bmw_fixture.routes.add(state_route, "state")
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION, log_responses=True)
await account.get_vehicles()
filenames = [Path(f.filename) for f in account.get_stored_responses()]
json_files = [f for f in filenames if f.suffix == ".json"]
txt_files = [f for f in filenames if f.suffix == ".txt"]
assert len(json_files) == json_count - 2 # missing on 1 state and 1 charging setting
assert len(txt_files) == 1 # error message from state, charging setting was not loaded anymore
@pytest.mark.asyncio
async def test_set_observer_value(bmw_fixture: respx.Router):
"""Test set_observer_position with valid arguments."""
account = await prepare_account_with_vehicles()
account.set_observer_position(1.0, 2.0)
assert account.config.observer_position == GPSPosition(1.0, 2.0)
@pytest.mark.asyncio
async def test_set_observer_not_set(bmw_fixture: respx.Router):
"""Test set_observer_position with no arguments."""
account = await prepare_account_with_vehicles()
assert account.config.observer_position is None
account.set_observer_position(17.99, 179.9)
assert account.config.observer_position == GPSPosition(17.99, 179.9)
@pytest.mark.asyncio
async def test_set_observer_invalid_values(bmw_fixture: respx.Router):
"""Test set_observer_position with invalid arguments."""
account = await prepare_account_with_vehicles()
with pytest.raises(ValueError, match="requires both 'latitude' and 'longitude' set"):
account.set_observer_position(1, None)
with pytest.raises(ValueError, match="requires both 'latitude' and 'longitude' set"):
account.set_observer_position(None, None)
account.set_observer_position(1, 2)
assert account.config.observer_position == GPSPosition(1.0, 2.0)
@pytest.mark.asyncio
async def test_set_use_metric_units(caplog):
"""Test (deprecated) use_metrics_units flag."""
# Default
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
assert len(caplog.records) == 0
metric_client = MyBMWClient(account.config)
assert (
metric_client.generate_default_header()["bmw-units-preferences"] == "d=KM;v=L;p=B;ec=KWH100KM;fc=L100KM;em=GKM;"
)
# Set to true
caplog.clear()
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION, use_metric_units=True)
assert len(caplog.records) == 1
metric_client = MyBMWClient(account.config)
assert (
metric_client.generate_default_header()["bmw-units-preferences"] == "d=KM;v=L;p=B;ec=KWH100KM;fc=L100KM;em=GKM;"
)
# Set to false
caplog.clear()
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION, use_metric_units=True)
assert len(caplog.records) == 1
metric_client = MyBMWClient(account.config)
assert (
metric_client.generate_default_header()["bmw-units-preferences"] == "d=KM;v=L;p=B;ec=KWH100KM;fc=L100KM;em=GKM;"
)
@pytest.mark.asyncio
async def test_refresh_token_getset(bmw_fixture: respx.Router):
"""Test getting/setting the refresh_token and gcid."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
assert account.refresh_token is None
await account.get_vehicles()
assert account.refresh_token == "another_token_string"
assert account.gcid == "DUMMY"
account.set_refresh_token("new_refresh_token")
assert account.refresh_token == "new_refresh_token"
assert account.gcid == "DUMMY"
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name("china"))
account.set_refresh_token("new_refresh_token", "dummy_gcid")
assert account.refresh_token == "new_refresh_token"
assert account.gcid == "dummy_gcid"
await account.get_vehicles()
assert account.refresh_token == "another_token_string"
assert account.gcid == "DUMMY"
@pytest.mark.asyncio
async def test_429_retry_ok_oauth_config(caplog, bmw_fixture: respx.Router):
"""Test the login flow using refresh_token."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
json_429 = {"statusCode": 429, "message": "Rate limit is exceeded. Try again in 2 seconds."}
bmw_fixture.get("/eadrax-ucs/v1/presentation/oauth/config").mock(
side_effect=[
httpx.Response(429, json=json_429),
httpx.Response(429, json=json_429),
httpx.Response(200, json=load_response(RESPONSE_DIR / "auth" / "oauth_config.json")),
]
)
caplog.set_level(logging.DEBUG)
with mock.patch("asyncio.sleep", new_callable=mock.AsyncMock):
await account.get_vehicles()
log_429 = [
r
for r in caplog.records
if r.module == "authentication" and "seconds due to 429 Too Many Requests" in r.message
]
assert len(log_429) == 2
@pytest.mark.asyncio
async def test_429_retry_raise_oauth_config(caplog, bmw_fixture: respx.Router):
"""Test the login flow using refresh_token."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
json_429 = {"statusCode": 429, "message": "Rate limit is exceeded. Try again in 2 seconds."}
bmw_fixture.get("/eadrax-ucs/v1/presentation/oauth/config").mock(return_value=httpx.Response(429, json=json_429))
caplog.set_level(logging.DEBUG)
with mock.patch("asyncio.sleep", new_callable=mock.AsyncMock), pytest.raises(MyBMWAPIError):
await account.get_vehicles()
log_429 = [
r
for r in caplog.records
if r.module == "authentication" and "seconds due to 429 Too Many Requests" in r.message
]
assert len(log_429) == 3
@pytest.mark.asyncio
async def test_429_retry_ok_authenticate(caplog, bmw_fixture: respx.Router):
"""Test the login flow using refresh_token."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
json_429 = {"statusCode": 429, "message": "Rate limit is exceeded. Try again in 2 seconds."}
bmw_fixture.post("/gcdm/oauth/authenticate").mock(
side_effect=[
httpx.Response(429, json=json_429),
httpx.Response(429, json=json_429),
MyBMWMockRouter.authenticate_sideeffect, # type: ignore[list-item]
MyBMWMockRouter.authenticate_sideeffect, # type: ignore[list-item]
]
)
caplog.set_level(logging.DEBUG)
with mock.patch("asyncio.sleep", new_callable=mock.AsyncMock):
await account.get_vehicles()
log_429 = [
r
for r in caplog.records
if r.module == "authentication" and "seconds due to 429 Too Many Requests" in r.message
]
assert len(log_429) == 2
@pytest.mark.asyncio
async def test_429_retry_raise_authenticate(caplog, bmw_fixture: respx.Router):
"""Test the login flow using refresh_token."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
json_429 = {"statusCode": 429, "message": "Rate limit is exceeded. Try again in 2 seconds."}
bmw_fixture.post("/gcdm/oauth/authenticate").mock(return_value=httpx.Response(429, json=json_429))
caplog.set_level(logging.DEBUG)
with mock.patch("asyncio.sleep", new_callable=mock.AsyncMock), pytest.raises(MyBMWAuthError):
await account.get_vehicles()
log_429 = [
r
for r in caplog.records
if r.module == "authentication" and "seconds due to 429 Too Many Requests" in r.message
]
assert len(log_429) == 3
@pytest.mark.asyncio
async def test_429_retry_ok_vehicles(caplog, bmw_fixture: respx.Router):
"""Test waiting on 429 for vehicles."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
json_429 = {"statusCode": 429, "message": "Rate limit is exceeded. Try again in 2 seconds."}
bmw_fixture.post(VEHICLES_URL).mock(
side_effect=[
httpx.Response(429, json=json_429),
httpx.Response(429, json=json_429),
*[
httpx.Response(200, json=load_response(RESPONSE_DIR / f"{brand.value}-eadrax-vcs_v5_vehicle-list.json"))
for brand in CarBrands
],
]
)
caplog.set_level(logging.DEBUG)
with mock.patch("asyncio.sleep", new_callable=mock.AsyncMock):
await account.get_vehicles()
log_429 = [
r
for r in caplog.records
if r.module == "authentication" and "seconds due to 429 Too Many Requests" in r.message
]
assert len(log_429) == 2
@pytest.mark.asyncio
async def test_429_retry_raise_vehicles(caplog, bmw_fixture: respx.Router):
"""Test waiting on 429 for vehicles and fail if it happens too often."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
json_429 = {"statusCode": 429, "message": "Rate limit is exceeded. Try again in 2 seconds."}
bmw_fixture.post(VEHICLES_URL).mock(return_value=httpx.Response(429, json=json_429))
caplog.set_level(logging.DEBUG)
with mock.patch("asyncio.sleep", new_callable=mock.AsyncMock), pytest.raises(MyBMWQuotaError):
await account.get_vehicles()
log_429 = [
r
for r in caplog.records
if r.module == "authentication" and "seconds due to 429 Too Many Requests" in r.message
]
assert len(log_429) == 3
@pytest.mark.asyncio
async def test_429_retry_with_login_ok_vehicles(bmw_fixture: respx.Router):
"""Test the login flow but experiencing a 429 first."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
json_429 = {"statusCode": 429, "message": "Rate limit is exceeded. Try again in 2 seconds."}
bmw_fixture.post(VEHICLES_URL).mock(
side_effect=[
httpx.Response(429, json=json_429),
httpx.Response(429, json=json_429),
*[
httpx.Response(200, json=load_response(RESPONSE_DIR / f"{brand.value}-eadrax-vcs_v5_vehicle-list.json"))
for brand in CarBrands
],
]
)
with mock.patch("asyncio.sleep", new_callable=mock.AsyncMock):
await account.get_vehicles()
@pytest.mark.asyncio
async def test_429_retry_with_login_raise_vehicles(bmw_fixture: respx.Router):
"""Test the error handling, experiencing a 429, 401 and another two 429."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
json_429 = {"statusCode": 429, "message": "Rate limit is exceeded. Try again in 2 seconds."}
bmw_fixture.post(VEHICLES_URL).mock(
side_effect=[
httpx.Response(429, json=json_429),
httpx.Response(401),
httpx.Response(429, json=json_429),
httpx.Response(429, json=json_429),
httpx.Response(429, json=json_429),
httpx.Response(429, json=json_429),
httpx.Response(429, json=json_429),
]
)
with mock.patch("asyncio.sleep", new_callable=mock.AsyncMock), pytest.raises(MyBMWQuotaError):
await account.get_vehicles()
@pytest.mark.asyncio
async def test_multiple_401(bmw_fixture: respx.Router):
"""Test the error handling, when multiple 401 are received in sequence."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
bmw_fixture.post(VEHICLES_URL).mock(
side_effect=[
httpx.Response(401),
httpx.Response(401),
]
)
with mock.patch("asyncio.sleep", new_callable=mock.AsyncMock), pytest.raises(MyBMWAuthError):
await account.get_vehicles()
@pytest.mark.asyncio
async def test_401_after_429_ok(bmw_fixture: respx.Router):
"""Test the error handling, when a 401 is received after exactly 3 429."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
await account.get_vehicles()
json_429 = {"statusCode": 429, "message": "Rate limit is exceeded. Try again in 2 seconds."}
# Recover after 3 429 and 1 401
bmw_fixture.post(VEHICLES_URL).mock(
side_effect=[
httpx.Response(429, json=json_429),
httpx.Response(429, json=json_429),
httpx.Response(429, json=json_429),
httpx.Response(401),
# Just simulate OK responses from now on
*[httpx.Response(200, json=load_response(RESPONSE_DIR / "bmw-eadrax-vcs_v5_vehicle-list.json"))] * 100,
]
)
with mock.patch("asyncio.sleep", new_callable=mock.AsyncMock):
await account.get_vehicles()
assert len(account.vehicles) == get_fingerprint_count("profiles")
@pytest.mark.asyncio
async def test_401_after_429_fail(bmw_fixture: respx.Router):
"""Test the error handling, when a 401 is received after exactly 3 429."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
json_429 = {"statusCode": 429, "message": "Rate limit is exceeded. Try again in 2 seconds."}
# Fail after 3 429 and 1 401 with another 429
bmw_fixture.post(VEHICLES_URL).mock(
side_effect=[
httpx.Response(429, json=json_429),
httpx.Response(429, json=json_429),
httpx.Response(429, json=json_429),
httpx.Response(401),
httpx.Response(429, json=json_429),
]
)
with mock.patch("asyncio.sleep", new_callable=mock.AsyncMock), pytest.raises(MyBMWQuotaError):
await account.get_vehicles()
@pytest.mark.asyncio
async def test_403_quota_exceeded_vehicles_usa(caplog, bmw_fixture: respx.Router):
"""Test 403 quota issues for vehicle state and fail if it happens too often."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
# get vehicles once
await account.get_vehicles()
bmw_fixture.get("/eadrax-vcs/v4/vehicles/state").mock(
return_value=httpx.Response(
403,
json={"statusCode": 403, "message": "Out of call volume quota. Quota will be replenished in 02:12:20."},
)
)
caplog.set_level(logging.DEBUG)
with mock.patch("asyncio.sleep", new_callable=mock.AsyncMock), pytest.raises(MyBMWQuotaError):
await account.get_vehicles()
log_quota = [r for r in caplog.records if "quota" in r.message]
assert len(log_quota) == 1
@pytest.mark.asyncio
async def test_incomplete_vehicle_details(caplog, bmw_fixture: respx.Router):
"""Test incorrect responses for vehicle details."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
# get vehicles once
await account.get_vehicles()
# We need to remove the existing state route first and add it back later as otherwise our error call is never
# matched (respx matches by order of routes and we don't replace the existing one)
state_route = bmw_fixture.routes.pop("state")
# JSON, but error
bmw_fixture.get("/eadrax-vcs/v4/vehicles/state", headers={"bmw-vin": VIN_I20}).respond(
500, json={"statusCode": 500, "message": "Something is broken."}
)
# No JSON
bmw_fixture.get("/eadrax-vcs/v4/vehicles/state", headers={"bmw-vin": VIN_G26}).respond(
500, text=load_response(RESPONSE_DIR / "auth" / "auth_error_internal_error.txt")
)
bmw_fixture.routes.add(state_route, "state")
await account.get_vehicles()
log_error = [r for r in caplog.records if "Unable to get details" in r.message]
assert len(log_error) == 2
@pytest.mark.asyncio
async def test_no_vehicle_details(caplog, bmw_fixture: respx.Router):
"""Test raising an exception if no responses for vehicle details are received."""
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)
await account.get_vehicles()
bmw_fixture.get("/eadrax-vcs/v4/vehicles/state").mock(
return_value=httpx.Response(
500,
json={"statusCode": 500, "message": "Something is broken."},
)
)
with pytest.raises(MyBMWAPIError):
await account.get_vehicles()
log_error = [r for r in caplog.records if "Unable to get details" in r.message]
assert len(log_error) == get_fingerprint_count("profiles")
@pytest.mark.asyncio
async def test_client_async_only(bmw_fixture: respx.Router):
"""Test that the Authentication providers only work async."""
with httpx.Client(auth=MyBMWAuthentication(TEST_USERNAME, TEST_PASSWORD, TEST_REGION)) as client, pytest.raises(
RuntimeError
):
client.get("/eadrax-ucs/v1/presentation/oauth/config")
with httpx.Client(auth=MyBMWLoginRetry()) as client, pytest.raises(RuntimeError):
client.get("/eadrax-ucs/v1/presentation/oauth/config")
@pytest.mark.asyncio
async def test_pillow_unavailable(monkeypatch: pytest.MonkeyPatch, bmw_fixture: respx.Router):
"""Test cases if Pillow is unavailable (i.e. lib is not installed with extra [china])."""
monkeypatch.setattr("importlib.import_module", mock.Mock(side_effect=ImportError))
# Test china (needs to throw exception)
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name("china"))
with pytest.raises(
expected_exception=ImportError,
match=r"Missing dependencies for region 'china'. Please install using bimmerconnected\[china\].",
):
await account.get_vehicles()
assert account is not None
assert len(account.vehicles) == 0
# But rest_of_world and north_america should work
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name("rest_of_world"))
await account.get_vehicles()
assert account is not None
assert len(account.vehicles) > 0
account = MyBMWAccount(TEST_USERNAME, TEST_PASSWORD, get_region_from_name("north_america"))
await account.get_vehicles()
assert account is not None
assert len(account.vehicles) > 0
|