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 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347
|
"""
Test the PyiCloudService and PyiCloudSession classes."""
# pylint: disable=protected-access
from typing import Any, List
from unittest.mock import MagicMock, mock_open, patch
import pytest
from fido2.hid import CtapHidDevice
from requests import HTTPError, Response
from pyicloud import PyiCloudService
from pyicloud.exceptions import (
PyiCloud2SARequiredException,
PyiCloudAcceptTermsException,
PyiCloudAPIResponseException,
PyiCloudFailedLoginException,
PyiCloudServiceNotActivatedException,
PyiCloudServiceUnavailable,
)
from pyicloud.services.calendar import CalendarService
from pyicloud.services.contacts import ContactsService
from pyicloud.services.hidemyemail import HideMyEmailService
from pyicloud.services.photos import PhotosService
from pyicloud.services.reminders import RemindersService
from pyicloud.services.ubiquity import UbiquityService
from pyicloud.session import PyiCloudSession
from pyicloud.utils import b64_encode
from tests.const import LOGIN_2FA
def test_authenticate_with_force_refresh(pyicloud_service: PyiCloudService) -> None:
"""Test the authenticate method with force_refresh=True."""
with (
patch("pyicloud.base.PyiCloudSession.post") as mock_post_response,
patch("pyicloud.base.PyiCloudService._validate_token") as validate_token,
):
pyicloud_service.session._data = {"session_token": "valid_token"}
mock_post_response.json.return_value = {
"apps": {"test_service": {"canLaunchWithOneFactor": True}},
"status": "success",
}
pyicloud_service.data = {
"apps": {"test_service": {"canLaunchWithOneFactor": True}}
}
validate_token = MagicMock(
return_value={
"status": "success",
"dsInfo": {"hsaVersion": 1},
"webservices": "TestWebservices",
}
)
pyicloud_service._validate_token = validate_token
pyicloud_service.authenticate(force_refresh=True, service="test_service")
mock_post_response.assert_called_once()
validate_token.assert_called_once()
def test_authenticate_with_missing_token(pyicloud_service: PyiCloudService) -> None:
"""Test the authenticate method with missing session_token."""
with (
patch("pyicloud.base.PyiCloudSession.get") as mock_get_response,
patch("pyicloud.base.PyiCloudSession.post") as mock_post_response,
patch.object(
pyicloud_service,
"_authenticate_with_token",
side_effect=[PyiCloudFailedLoginException("a"), None],
) as mock_authenticate_with_token,
):
mock_post_response.return_value.json.side_effect = [
{
"salt": "U29tZVNhbHQ=",
"b": "U29tZUJ5dGVz",
"c": "TestC",
"protocol": "s2k",
"iteration": 1000,
"dsInfo": {"hsaVersion": 1},
"hsaChallengeRequired": False,
"webservices": "TestWebservices",
},
None,
]
pyicloud_service.session.post = mock_post_response
pyicloud_service.session._data = {}
pyicloud_service.params = {}
pyicloud_service.authenticate()
assert mock_get_response.call_count == 1
assert mock_post_response.call_count == 2
assert mock_authenticate_with_token.call_count == 2
def test_validate_2fa_code(pyicloud_service: PyiCloudService) -> None:
"""Test the validate_2fa_code method with a valid code."""
pyicloud_service.data = {"dsInfo": {"hsaVersion": 1}, "hsaChallengeRequired": False}
with patch("pyicloud.base.PyiCloudSession") as mock_session:
pyicloud_service._session = mock_session
mock_session.data = {
"scnt": "test_scnt",
"session_id": "test_session_id",
"session_token": "test_session_token",
}
mock_post_response = MagicMock()
mock_post_response.status_code = 200
mock_post_response.json.return_value = {"success": True}
mock_session.post.return_value = mock_post_response
assert pyicloud_service.validate_2fa_code("123456")
def test_validate_2fa_code_failure(pyicloud_service: PyiCloudService) -> None:
"""Test the validate_2fa_code method with an invalid code."""
exception = PyiCloudAPIResponseException("Invalid code")
exception.code = -21669
with patch("pyicloud.base.PyiCloudSession") as mock_session:
mock_session.post.side_effect = exception
pyicloud_service._session = mock_session
assert not pyicloud_service.validate_2fa_code("000000")
@patch("pyicloud.base.CtapHidDevice.list_devices", return_value=[MagicMock()])
@patch("pyicloud.base.Fido2Client")
def test_confirm_security_key_success(
mock_fido2_client_cls, mock_list_devices, pyicloud_service: PyiCloudService
) -> None:
"""Test that the FIDO2 WebAuthn flow works"""
rp_id = "example.com"
challenge = "ZmFrZV9jaGFsbGVuZ2U"
# Arrange
pyicloud_service._submit_webauthn_assertion_response = MagicMock()
pyicloud_service.trust_session = MagicMock()
# Simulated WebAuthn options returned from backend
pyicloud_service._auth_data = {
"fsaChallenge": {
"challenge": challenge, # base64url(fake_challenge)
"keyHandles": ["a2V5MQ", "a2V5Mg"], # base64url(fake_key_ids)
"rpId": rp_id,
}
}
# Simulated FIDO2 response
mock_response = MagicMock()
mock_response.response = MagicMock()
mock_response.response.client_data = b"client_data"
mock_response.response.signature = b"signature"
mock_response.response.authenticator_data = b"auth_data"
mock_response.response.user_handle = b"user_handle"
mock_response.raw_id = b"cred_id"
mock_fido2_client = MagicMock()
mock_fido2_client.get_assertion.return_value.get_response.return_value = (
mock_response
)
mock_fido2_client_cls.return_value = mock_fido2_client
# Act
pyicloud_service.confirm_security_key()
# Assert
mock_list_devices.assert_called_once()
mock_fido2_client.get_assertion.assert_called_once()
# Check if data was submitted correctly
pyicloud_service._submit_webauthn_assertion_response.assert_called_once_with(
{
"challenge": challenge,
"rpId": rp_id,
"clientData": b64_encode(mock_response.response.client_data),
"signatureData": b64_encode(mock_response.response.signature),
"authenticatorData": b64_encode(mock_response.response.authenticator_data),
"userHandle": b64_encode(mock_response.response.user_handle),
"credentialID": b64_encode(mock_response.raw_id),
}
)
pyicloud_service.trust_session.assert_called_once()
def test_get_webservice_url_success(pyicloud_service: PyiCloudService) -> None:
"""Test the get_webservice_url method with a valid key."""
pyicloud_service._webservices = {"test_key": {"url": "https://example.com"}}
url: str = pyicloud_service.get_webservice_url("test_key")
assert url == "https://example.com"
def test_get_webservice_url_failure(pyicloud_service: PyiCloudService) -> None:
"""Test the get_webservice_url method with an invalid key."""
pyicloud_service._webservices = {}
with pytest.raises(PyiCloudServiceNotActivatedException):
pyicloud_service.get_webservice_url("invalid_key")
def test_trust_session_success(pyicloud_service: PyiCloudService) -> None:
"""Test the trust_session method with a successful response."""
with patch("pyicloud.base.PyiCloudSession") as mock_session:
mock_session.data = {
"scnt": "test_scnt",
"session_id": "test_session_id",
"session_token": "test_session_token",
}
mock_session.post.return_value.json.return_value = {
"termsUpdateNeeded": False,
"hsaTrustedBrowser": True,
}
pyicloud_service._session = mock_session
assert pyicloud_service.trust_session()
def test_trust_session_failure(pyicloud_service: PyiCloudService) -> None:
"""Test the trust_session method with a failed response."""
with patch("pyicloud.base.PyiCloudSession") as mock_session:
pyicloud_service._session = mock_session
mock_session.get.side_effect = PyiCloudAPIResponseException("Trust failed")
assert not pyicloud_service.trust_session()
def test_cookiejar_path_property(pyicloud_session: PyiCloudSession) -> None:
"""Test the cookiejar_path property."""
path: str = pyicloud_session.cookiejar_path
assert isinstance(path, str)
def test_session_path_property(pyicloud_session: PyiCloudSession) -> None:
"""Test the session_path property."""
path: str = pyicloud_session.session_path
assert isinstance(path, str)
def test_requires_2sa_property(pyicloud_service: PyiCloudService) -> None:
"""Test the requires_2sa property."""
pyicloud_service.data = {"dsInfo": {"hsaVersion": 2}}
assert pyicloud_service.requires_2sa
def test_requires_2fa_property(pyicloud_service: PyiCloudService) -> None:
"""Test the requires_2fa property."""
pyicloud_service.data = LOGIN_2FA
assert pyicloud_service.requires_2fa
def test_is_trusted_session_property(pyicloud_service: PyiCloudService) -> None:
"""Test the is_trusted_session property."""
pyicloud_service.data = {"dsInfo": {"hsaVersion": 2}}
assert not pyicloud_service.is_trusted_session
def test_request_success(pyicloud_service_working: PyiCloudService) -> None:
"""Test the request method with a successful response."""
with (
patch("requests.Session.request") as mock_request,
patch("builtins.open", new_callable=mock_open),
patch("os.path.exists", return_value=True),
patch("http.cookiejar.LWPCookieJar.save") as mock_save,
patch("http.cookiejar.LWPCookieJar.load") as mock_load,
):
mock_response = MagicMock()
mock_response.status_code = 200
mock_response.json.return_value = {"success": True}
mock_response.headers.get.return_value = "application/json"
mock_request.return_value = mock_response
pyicloud_session = PyiCloudSession(
service=pyicloud_service_working,
client_id="",
cookie_directory="",
)
response: Response = pyicloud_session.request(
"POST", "https://example.com", data={"key": "value"}
)
assert response.json() == {"success": True}
assert response.headers.get("Content-Type") == "application/json"
mock_request.assert_called_once_with(
method="POST",
url="https://example.com",
data={"key": "value"},
params=None,
headers=None,
cookies=None,
files=None,
auth=None,
timeout=None,
allow_redirects=True,
proxies=None,
hooks=None,
stream=None,
verify=None,
cert=None,
json=None,
)
mock_save.assert_called_once_with(
filename="testexamplecom.cookiejar",
ignore_discard=True,
ignore_expires=False,
)
mock_load.assert_called_once_with(
filename="testexamplecom.cookiejar",
ignore_discard=True,
ignore_expires=False,
)
def test_request_failure(pyicloud_service_working: PyiCloudService) -> None:
"""Test the request method with a failure response."""
with (
patch("requests.Session.request") as mock_request,
patch("builtins.open", new_callable=mock_open) as open_mock,
patch("http.cookiejar.LWPCookieJar.save") as mock_save,
):
mock_response = MagicMock()
mock_response.status_code = 400
mock_response.ok = False
mock_response.json.return_value = {"error": "Bad Request"}
mock_response.headers.get.return_value = "application/json"
mock_request.return_value = mock_response
pyicloud_session = PyiCloudSession(
pyicloud_service_working, "", cookie_directory=""
)
with pytest.raises(PyiCloudAPIResponseException):
pyicloud_session.request(
"POST", "https://example.com", data={"key": "value"}
)
mock_request.assert_called_once_with(
method="POST",
url="https://example.com",
data={"key": "value"},
params=None,
headers=None,
cookies=None,
files=None,
auth=None,
timeout=None,
allow_redirects=True,
proxies=None,
hooks=None,
stream=None,
verify=None,
cert=None,
json=None,
)
mock_save.assert_called_once()
assert open_mock.call_count == 2
def test_request_with_custom_headers(pyicloud_service_working: PyiCloudService) -> None:
"""Test the request method with custom headers."""
with (
patch("requests.Session.request") as mock_request,
patch("builtins.open", new_callable=mock_open),
patch("http.cookiejar.LWPCookieJar.save") as mock_save,
):
mock_response = MagicMock()
mock_response.status_code = 200
mock_response.json.return_value = {"data": "header test"}
mock_response.headers.get.return_value = "application/json"
mock_request.return_value = mock_response
pyicloud_session = PyiCloudSession(
pyicloud_service_working, "", cookie_directory=""
)
response: Response = pyicloud_session.request(
"GET",
"https://example.com",
headers={"Custom-Header": "Value"},
)
assert response.json() == {"data": "header test"}
assert response.headers.get("Content-Type") == "application/json"
mock_request.assert_called_once_with(
method="GET",
url="https://example.com",
data=None,
headers={"Custom-Header": "Value"},
params=None,
cookies=None,
files=None,
auth=None,
timeout=None,
allow_redirects=True,
proxies=None,
hooks=None,
stream=None,
verify=None,
cert=None,
json=None,
)
mock_save.assert_called_once()
def test_request_error_handling_for_response_conditions() -> None:
"""Mock the get_webservice_url to return a valid fmip_url."""
pyicloud_service = MagicMock(spec=PyiCloudService)
with (
pytest.raises(PyiCloudAPIResponseException),
patch("requests.Session.request") as mock_request,
patch("builtins.open", new_callable=mock_open),
patch("os.path.exists", return_value=False),
patch("http.cookiejar.LWPCookieJar.save"),
patch.object(
pyicloud_service,
"get_webservice_url",
return_value="https://fmip.example.com",
),
):
# Mock the response with conditions that cause an error.
mock_response = MagicMock()
mock_response.status_code = 500
mock_response.ok = False
mock_response.json.return_value = {"error": "Server Error"}
mock_response.headers.get.return_value = "application/json"
mock_request.return_value = mock_response
pyicloud_session = PyiCloudSession(pyicloud_service, "", cookie_directory="")
pyicloud_service.data = {"session_token": "valid_token"}
# Use the mocked fmip_url in the request.
pyicloud_session.request("GET", "https://fmip.example.com/path")
def test_raise_error_2sa_required(pyicloud_session: PyiCloudSession) -> None:
"""Test the _raise_error method with a 2SA required exception."""
with (
pytest.raises(PyiCloud2SARequiredException),
patch("pyicloud.base.PyiCloudService.requires_2sa", return_value=True),
):
pyicloud_session._raise_error(
code=401,
reason="Missing X-APPLE-WEBAUTH-TOKEN cookie",
response=MagicMock(),
)
def test_raise_error_service_not_activated(pyicloud_session: PyiCloudSession) -> None:
"""Test the _raise_error method with a service not activated exception."""
with pytest.raises(PyiCloudServiceNotActivatedException):
pyicloud_session._raise_error(
code="ZONE_NOT_FOUND", reason="ServiceNotActivated", response=MagicMock()
)
def test_raise_error_access_denied(pyicloud_session: PyiCloudSession) -> None:
"""Test the _raise_error method with an access denied exception."""
with pytest.raises(PyiCloudAPIResponseException):
pyicloud_session._raise_error(
code="ACCESS_DENIED", reason="ACCESS_DENIED", response=MagicMock()
)
def test_request_pcs_for_service_icdrs_not_disabled(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _request_pcs_for_service when ICDRS is not disabled (should early return)."""
mock_logger = MagicMock()
pyicloud_service._session = MagicMock()
pyicloud_service.session.post = MagicMock(
return_value=MagicMock(json=MagicMock(return_value={"isICDRSDisabled": False}))
)
pyicloud_service.params = {}
with patch("pyicloud.base.LOGGER", mock_logger):
pyicloud_service._send_pcs_request = MagicMock()
pyicloud_service._request_pcs_for_service("photos")
mock_logger.warning.assert_called_once_with("ICDRS is not disabled")
pyicloud_service._send_pcs_request.assert_not_called()
def test_request_pcs_for_service_consent_needed_and_notification_sent(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _request_pcs_for_service when device consent is needed and notification is sent."""
# First call: ICDRS disabled, device not consented
# Second call: device consented (simulate after waiting)
consent_states: List[dict[str, bool]] = [
{"isICDRSDisabled": True, "isDeviceConsentedForPCS": False},
{"isICDRSDisabled": True, "isDeviceConsentedForPCS": True},
]
pyicloud_service._check_pcs_consent = MagicMock(side_effect=consent_states)
pyicloud_service._session = MagicMock()
pyicloud_service.params = {}
pyicloud_service._session.post.return_value.json.side_effect = [
{"isDeviceConsentNotificationSent": True},
{"status": "success", "message": "ok"},
]
with patch("time.sleep"):
pyicloud_service._request_pcs_for_service("photos")
pyicloud_service._session.post.assert_any_call(
f"{pyicloud_service._setup_endpoint}/enableDeviceConsentForPCS",
params=pyicloud_service.params,
)
# Should not raise
def test_request_pcs_for_service_consent_needed_and_notification_not_sent(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _request_pcs_for_service when device consent notification is not sent (should raise)."""
pyicloud_service._check_pcs_consent = MagicMock(
return_value={"isICDRSDisabled": True, "isDeviceConsentedForPCS": False}
)
pyicloud_service._session = MagicMock()
pyicloud_service.params = {}
pyicloud_service._session.post.return_value.json.return_value = {
"isDeviceConsentNotificationSent": False
}
with pytest.raises(
PyiCloudAPIResponseException, match="Unable to request PCS access!"
):
pyicloud_service._request_pcs_for_service("photos")
def test_request_pcs_for_service_pcs_consent_waits(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _request_pcs_for_service waits for PCS consent and then proceeds."""
# Simulate PCS consent not granted for first 2 tries, then granted
consent_states: List[dict[str, bool]] = [
{"isICDRSDisabled": True, "isDeviceConsentedForPCS": False},
{"isICDRSDisabled": True, "isDeviceConsentedForPCS": False},
{"isICDRSDisabled": True, "isDeviceConsentedForPCS": True},
]
pyicloud_service._check_pcs_consent = MagicMock(side_effect=consent_states)
pyicloud_service._session = MagicMock()
pyicloud_service.params = {}
pyicloud_service._session.post.return_value.json.return_value = {
"isDeviceConsentNotificationSent": True
}
pyicloud_service._send_pcs_request = MagicMock(
return_value={"status": "success", "message": "ok"}
)
with patch("time.sleep"):
pyicloud_service._request_pcs_for_service("photos")
assert pyicloud_service._send_pcs_request.called
def test_request_pcs_for_service_success_on_first_attempt(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _request_pcs_for_service grants PCS access on first attempt."""
pyicloud_service._check_pcs_consent = MagicMock(
return_value={"isICDRSDisabled": True, "isDeviceConsentedForPCS": True}
)
pyicloud_service._session = MagicMock()
pyicloud_service.params = {}
pyicloud_service._send_pcs_request = MagicMock(
return_value={"status": "success", "message": "ok"}
)
pyicloud_service._request_pcs_for_service("photos")
pyicloud_service._send_pcs_request.assert_called_once_with(
"photos", derived_from_user_action=True
)
def test_request_pcs_for_service_retries_on_cookie_messages(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _request_pcs_for_service retries on known cookie messages and succeeds."""
pyicloud_service._check_pcs_consent = MagicMock(
return_value={"isICDRSDisabled": True, "isDeviceConsentedForPCS": True}
)
pyicloud_service._session = MagicMock()
pyicloud_service.params = {}
responses: List[dict[str, str]] = [
{"status": "error", "message": "Requested the device to upload cookies."},
{"status": "error", "message": "Cookies not available yet on server."},
{"status": "success", "message": "ok"},
]
pyicloud_service._send_pcs_request = MagicMock(side_effect=responses)
with patch("time.sleep"):
pyicloud_service._request_pcs_for_service("photos")
assert pyicloud_service._send_pcs_request.call_count == 3
def test_request_pcs_for_service_raises_on_unknown_message(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _request_pcs_for_service raises on unknown PCS state message."""
pyicloud_service._check_pcs_consent = MagicMock(
return_value={"isICDRSDisabled": True, "isDeviceConsentedForPCS": True}
)
pyicloud_service._session = MagicMock()
pyicloud_service.params = {}
pyicloud_service._send_pcs_request = MagicMock(
return_value={"status": "error", "message": "Some unknown error"}
)
mock_logger = MagicMock()
with (
pytest.raises(
PyiCloudAPIResponseException, match="Unable to request PCS access!"
),
patch("pyicloud.base.LOGGER", mock_logger),
):
pyicloud_service._request_pcs_for_service("photos")
mock_logger.error.assert_called()
def test_handle_accept_terms_no_terms_update_needed(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _handle_accept_terms when no terms update is needed (should do nothing)."""
pyicloud_service.data = {"termsUpdateNeeded": False}
login_data: dict[str, str] = {"test": "data"}
# Should not raise or call anything
pyicloud_service._session = MagicMock()
pyicloud_service._accept_terms = True
pyicloud_service._handle_accept_terms(login_data)
pyicloud_service._session.get.assert_not_called()
pyicloud_service._session.post.assert_not_called()
def test_handle_accept_terms_terms_update_needed_accept_terms_false(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _handle_accept_terms when terms update is needed and accept_terms is
False (should raise)."""
pyicloud_service.data = {"termsUpdateNeeded": True}
pyicloud_service._accept_terms = False
login_data: dict[str, str] = {"test": "data"}
with pytest.raises(
PyiCloudAcceptTermsException,
match="You must accept the updated terms of service",
):
pyicloud_service._handle_accept_terms(login_data)
def test_handle_accept_terms_terms_update_needed_accept_terms_true_success(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _handle_accept_terms when terms update is needed and accept_terms is
True (should accept terms)."""
pyicloud_service.data = {
"termsUpdateNeeded": True,
"dsInfo": {"languageCode": "en_US"},
}
pyicloud_service._accept_terms = True
login_data: dict[str, str] = {"test": "data"}
# Mock session.get and session.post
mock_get = MagicMock()
mock_post = MagicMock()
pyicloud_service.session.get = mock_get
pyicloud_service.session.post = mock_post
# Mock getTerms response
get_terms_response = MagicMock()
get_terms_response.raise_for_status = MagicMock()
get_terms_response.json.return_value = {"iCloudTerms": {"version": 42}}
mock_get.side_effect = [get_terms_response, get_terms_response]
# Mock accountLogin response
post_response = MagicMock()
post_response.raise_for_status = MagicMock()
post_response.json.return_value = {"new": "data"}
mock_post.return_value = post_response
pyicloud_service._handle_accept_terms(login_data)
# Check calls
mock_get.assert_any_call(
f"{pyicloud_service._setup_endpoint}/getTerms",
params=pyicloud_service.params,
json={"locale": "en_US"},
)
mock_get.assert_any_call(
f"{pyicloud_service._setup_endpoint}/repairDone",
params=pyicloud_service.params,
json={"acceptedICloudTerms": 42},
)
mock_post.assert_called_once_with(
f"{pyicloud_service._setup_endpoint}/accountLogin", json=login_data
)
assert pyicloud_service.data == {"new": "data"}
def test_handle_accept_terms_terms_update_needed_accept_terms_true_http_error(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _handle_accept_terms when terms update is needed and accept_terms is
True but HTTP error occurs."""
pyicloud_service.data = {
"termsUpdateNeeded": True,
"dsInfo": {"languageCode": "en_US"},
}
pyicloud_service._accept_terms = True
login_data: dict[str, str] = {"test": "data"}
# Mock session.get to raise HTTPError
mock_get = MagicMock()
pyicloud_service.session.get = mock_get
mock_get.side_effect = HTTPError("HTTP error")
with pytest.raises(HTTPError):
pyicloud_service._handle_accept_terms(login_data)
def test_handle_accept_terms_terms_update_needed_accept_terms_true_post_error(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _handle_accept_terms when terms update is needed and accept_terms is
True but POST raises HTTPError."""
pyicloud_service.data = {
"termsUpdateNeeded": True,
"dsInfo": {"languageCode": "en_US"},
}
pyicloud_service._accept_terms = True
login_data: dict[str, str] = {"test": "data"}
# Mock session.get for getTerms and repairDone
mock_get = MagicMock()
pyicloud_service.session.get = mock_get
get_terms_response = MagicMock()
get_terms_response.raise_for_status = MagicMock()
get_terms_response.json.return_value = {"iCloudTerms": {"version": 42}}
mock_get.side_effect = [get_terms_response, get_terms_response]
# Mock session.post to raise HTTPError
mock_post = MagicMock()
pyicloud_service.session.post = mock_post
mock_post.side_effect = HTTPError("POST error")
with pytest.raises(HTTPError):
pyicloud_service._handle_accept_terms(login_data)
def test_validate_token_success(pyicloud_service: PyiCloudService) -> None:
"""Test _validate_token returns JSON when X-APPLE-WEBAUTH-TOKEN is present and
request succeeds."""
with (
patch.object(pyicloud_service.session.cookies, "get", return_value="token"),
patch.object(pyicloud_service.session, "post") as mock_post,
):
mock_response = MagicMock()
mock_response.json.return_value = {"status": "success"}
mock_post.return_value = mock_response
result = pyicloud_service._validate_token()
assert result == {"status": "success"}
mock_post.assert_called_once_with(
f"{pyicloud_service._setup_endpoint}/validate", data="null"
)
def test_validate_token_missing_cookie_raises(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _validate_token raises when X-APPLE-WEBAUTH-TOKEN cookie is missing."""
with patch.object(pyicloud_service.session.cookies, "get", return_value=None):
with pytest.raises(
PyiCloudAPIResponseException, match="Missing X-APPLE-WEBAUTH-TOKEN cookie"
):
pyicloud_service._validate_token()
def test_validate_token_post_raises_exception(
pyicloud_service: PyiCloudService,
) -> None:
"""Test _validate_token raises when session.post raises PyiCloudAPIResponseException."""
with (
patch.object(pyicloud_service.session.cookies, "get", return_value="token"),
patch.object(
pyicloud_service.session,
"post",
side_effect=PyiCloudAPIResponseException("Invalid token"),
),
):
with pytest.raises(PyiCloudAPIResponseException, match="Invalid token"):
pyicloud_service._validate_token()
def test_str_and_repr(pyicloud_service: PyiCloudService) -> None:
"""Test __str__ and __repr__ methods."""
s = str(pyicloud_service)
r: str = repr(pyicloud_service)
assert s.startswith("iCloud API:")
assert r.startswith("<iCloud API:")
def test_account_name_property(pyicloud_service: PyiCloudService) -> None:
"""Test account_name property returns the correct Apple ID."""
assert pyicloud_service.account_name == pyicloud_service._apple_id
def test_requires_2sa_true(pyicloud_service: PyiCloudService) -> None:
"""Test requires_2sa returns True when hsaVersion >= 1 and not trusted."""
pyicloud_service.data = {
"dsInfo": {"hsaVersion": 1},
"hsaChallengeRequired": True,
"hsaTrustedBrowser": False,
}
assert pyicloud_service.requires_2sa
def test_requires_2sa_false(pyicloud_service: PyiCloudService) -> None:
"""Test requires_2sa returns False when hsaVersion < 1."""
pyicloud_service.data = {"dsInfo": {"hsaVersion": 0}}
assert not pyicloud_service.requires_2sa
def test_requires_2fa_true(pyicloud_service: PyiCloudService) -> None:
"""Test requires_2fa returns True when hsaVersion == 2 and not trusted."""
pyicloud_service.data = {
"dsInfo": {"hsaVersion": 2},
"hsaChallengeRequired": True,
"hsaTrustedBrowser": False,
}
assert pyicloud_service.requires_2fa
def test_requires_2fa_false(pyicloud_service: PyiCloudService) -> None:
"""Test requires_2fa returns False when hsaVersion != 2."""
pyicloud_service.data = {"dsInfo": {"hsaVersion": 1}}
assert not pyicloud_service.requires_2fa
def test_is_trusted_session_true(pyicloud_service: PyiCloudService) -> None:
"""Test is_trusted_session returns True when hsaTrustedBrowser is True."""
pyicloud_service.data = {"hsaTrustedBrowser": True}
assert pyicloud_service.is_trusted_session
def test_is_trusted_session_false(pyicloud_service: PyiCloudService) -> None:
"""Test is_trusted_session returns False when hsaTrustedBrowser is False."""
pyicloud_service.data = {"hsaTrustedBrowser": False}
assert not pyicloud_service.is_trusted_session
def test_get_auth_headers_overrides(pyicloud_service: PyiCloudService) -> None:
"""Test _get_auth_headers applies overrides."""
pyicloud_service.session.data["scnt"] = "test_scnt"
pyicloud_service.session.data["session_id"] = "test_session_id"
headers: dict[str, Any] = pyicloud_service._get_auth_headers(
{"Extra-Header": "Value"}
)
assert headers["scnt"] == "test_scnt"
assert headers["X-Apple-ID-Session-Id"] == "test_session_id"
assert headers["Extra-Header"] == "Value"
def test_trusted_devices_calls_session_get(pyicloud_service: PyiCloudService) -> None:
"""Test trusted_devices property calls session.get and returns devices."""
mock_response = MagicMock()
mock_response.json.return_value = {"devices": [{"id": "device1"}]}
pyicloud_service.session.get = MagicMock(return_value=mock_response)
devices: list[dict[str, Any]] = pyicloud_service.trusted_devices
assert devices == [{"id": "device1"}]
pyicloud_service.session.get.assert_called_once()
def test_send_verification_code_success(pyicloud_service: PyiCloudService) -> None:
"""Test send_verification_code returns True on success."""
mock_response = MagicMock()
mock_response.json.return_value = {"success": True}
pyicloud_service.session.post = MagicMock(return_value=mock_response)
result = pyicloud_service.send_verification_code({"id": "device1"})
assert result is True
def test_send_verification_code_failure(pyicloud_service: PyiCloudService) -> None:
"""Test send_verification_code returns False on failure."""
mock_response = MagicMock()
mock_response.json.return_value = {"success": False}
pyicloud_service.session.post = MagicMock(return_value=mock_response)
result: bool = pyicloud_service.send_verification_code({"id": "device1"})
assert result is False
def test_validate_verification_code_success(pyicloud_service: PyiCloudService) -> None:
"""Test validate_verification_code returns True when code is valid."""
pyicloud_service.session.post = MagicMock()
pyicloud_service.trust_session = MagicMock(return_value=True)
result: bool = pyicloud_service.validate_verification_code(
{"id": "device1"}, "123456"
)
assert result is True
def test_validate_verification_code_wrong_code(
pyicloud_service: PyiCloudService,
) -> None:
"""Test validate_verification_code returns False on wrong code."""
exc = PyiCloudAPIResponseException("Invalid code")
exc.code = -21669
pyicloud_service.session.post = MagicMock(side_effect=exc)
result: bool = pyicloud_service.validate_verification_code(
{"id": "device1"}, "000000"
)
assert result is False
def test_validate_verification_code_raises_other(
pyicloud_service: PyiCloudService,
) -> None:
"""Test validate_verification_code raises on unknown error."""
exc = PyiCloudAPIResponseException("Other error")
exc.code = 12345
pyicloud_service.session.post = MagicMock(side_effect=exc)
with pytest.raises(PyiCloudAPIResponseException):
pyicloud_service.validate_verification_code({"id": "device1"}, "000000")
def test_security_key_names_returns_key_names(
pyicloud_service: PyiCloudService,
) -> None:
"""Test security_key_names property returns keyNames from options."""
pyicloud_service._auth_data = {"keyNames": ["key1", "key2"]}
assert pyicloud_service.security_key_names == ["key1", "key2"]
def test_fido2_devices_lists_devices(pyicloud_service: PyiCloudService) -> None:
"""Test fido2_devices property lists devices."""
with patch(
"pyicloud.base.CtapHidDevice.list_devices", return_value=[MagicMock()]
) as mock_list:
devices: List[CtapHidDevice] = pyicloud_service.fido2_devices
assert isinstance(devices, list)
mock_list.assert_called_once()
def test_confirm_security_key_no_devices_raises(
pyicloud_service: PyiCloudService,
) -> None:
"""Test confirm_security_key raises if no FIDO2 devices found."""
pyicloud_service._auth_data = {
"fsaChallenge": {"challenge": "c", "keyHandles": [], "rpId": "rp"}
}
with patch("pyicloud.base.CtapHidDevice.list_devices", return_value=[]):
with pytest.raises(RuntimeError, match="No FIDO2 devices found"):
pyicloud_service.confirm_security_key()
def test_get_webservice_url_raises_if_missing(
pyicloud_service: PyiCloudService,
) -> None:
"""Test get_webservice_url raises if key missing."""
pyicloud_service._webservices = None
with pytest.raises(PyiCloudServiceNotActivatedException):
pyicloud_service.get_webservice_url("missing_key")
def test_get_webservice_url_returns_url(pyicloud_service: PyiCloudService) -> None:
"""Test get_webservice_url returns correct url."""
pyicloud_service._webservices = {"foo": {"url": "https://foo.com"}}
assert pyicloud_service.get_webservice_url("foo") == "https://foo.com"
def test_str_returns_expected_format(pyicloud_service: PyiCloudService) -> None:
"""Test __str__ method."""
assert str(pyicloud_service).startswith("iCloud API:")
def test_repr_returns_expected_format(pyicloud_service: PyiCloudService) -> None:
"""Test __repr__ method."""
assert repr(pyicloud_service).startswith("<iCloud API:")
def test_account_name_property_returns_apple_id(
pyicloud_service: PyiCloudService,
) -> None:
"""Test account_name property returns the correct Apple ID."""
assert pyicloud_service.account_name == pyicloud_service._apple_id
def test_hidemyemail_returns_service(pyicloud_service: PyiCloudService) -> None:
"""Test hidemyemail property returns HideMyEmailService instance."""
mock_hme_service = MagicMock()
with (
patch.object(
pyicloud_service,
"get_webservice_url",
return_value="https://hme.example.com",
),
patch(
"pyicloud.base.HideMyEmailService", return_value=mock_hme_service
) as mock_hme_cls,
):
pyicloud_service._hidemyemail = None
result: HideMyEmailService = pyicloud_service.hidemyemail
mock_hme_cls.assert_called_once_with(
service_root="https://hme.example.com",
session=pyicloud_service.session,
params=pyicloud_service.params,
)
assert result == mock_hme_service
def test_hidemyemail_returns_cached_instance(pyicloud_service: PyiCloudService) -> None:
"""Test hidemyemail property returns cached instance if already set."""
mock_hme_service = MagicMock()
pyicloud_service._hidemyemail = mock_hme_service
result: HideMyEmailService = pyicloud_service.hidemyemail
assert result == mock_hme_service
def test_hidemyemail_raises_on_api_exception(pyicloud_service: PyiCloudService) -> None:
"""Test hidemyemail property raises PyiCloudServiceUnavailable on API exception."""
with (
patch.object(
pyicloud_service,
"get_webservice_url",
return_value="https://hme.example.com",
),
patch(
"pyicloud.base.HideMyEmailService",
side_effect=PyiCloudAPIResponseException("error"),
),
):
pyicloud_service._hidemyemail = None
with pytest.raises(
PyiCloudServiceUnavailable, match="Hide My Email service not available"
):
_: HideMyEmailService = pyicloud_service.hidemyemail
def test_files_returns_service(pyicloud_service: PyiCloudService) -> None:
"""Test files property returns UbiquityService instance."""
mock_files_service = MagicMock()
with (
patch.object(
pyicloud_service,
"get_webservice_url",
return_value="https://files.example.com",
),
patch(
"pyicloud.base.UbiquityService", return_value=mock_files_service
) as mock_files_cls,
):
pyicloud_service._files = None
result: UbiquityService = pyicloud_service.files
mock_files_cls.assert_called_once_with(
service_root="https://files.example.com",
session=pyicloud_service.session,
params=pyicloud_service.params,
)
assert result == mock_files_service
def test_files_returns_cached_instance(
pyicloud_service: PyiCloudService,
) -> None:
"""Test files property returns cached instance if already set."""
mock_files_service = MagicMock()
pyicloud_service._files = mock_files_service
result: UbiquityService = pyicloud_service.files
assert result == mock_files_service
def test_files_raises_on_api_exception(
pyicloud_service: PyiCloudService,
) -> None:
"""Test files property raises PyiCloudServiceUnavailable on API exception."""
with (
patch.object(
pyicloud_service,
"get_webservice_url",
return_value="https://files.example.com",
),
patch(
"pyicloud.base.UbiquityService",
side_effect=PyiCloudAPIResponseException("error"),
),
):
pyicloud_service._files = None
with pytest.raises(
PyiCloudServiceUnavailable, match="Files service not available"
):
_: UbiquityService = pyicloud_service.files
def test_files_raises_on_account_migrated(
pyicloud_service: PyiCloudService,
) -> None:
"""Test files property raises specific message if Account migrated."""
exc = PyiCloudAPIResponseException("Account migrated")
exc.reason = "Account migrated"
with (
patch.object(
pyicloud_service,
"get_webservice_url",
return_value="https://files.example.com",
),
patch(
"pyicloud.base.UbiquityService",
side_effect=exc,
),
):
pyicloud_service._files = None
with pytest.raises(
PyiCloudServiceUnavailable,
match="Files service not available use `api.drive` instead",
):
_: UbiquityService = pyicloud_service.files
def test_photos_returns_service(pyicloud_service: PyiCloudService) -> None:
"""Test photos property returns PhotosService instance."""
mock_photos_service = MagicMock()
with (
patch.object(
pyicloud_service,
"get_webservice_url",
side_effect=[
"https://photos.example.com",
"https://upload.example.com",
"https://shared.example.com",
],
),
patch(
"pyicloud.base.PhotosService", return_value=mock_photos_service
) as mock_photos_cls,
patch.object(pyicloud_service, "_request_pcs_for_service"),
):
pyicloud_service._photos = None
pyicloud_service.data = {"dsInfo": {"dsid": "12345"}}
result: PhotosService = pyicloud_service.photos
mock_photos_cls.assert_called_once_with(
service_root="https://photos.example.com",
session=pyicloud_service.session,
params=pyicloud_service.params,
upload_url="https://upload.example.com",
shared_streams_url="https://shared.example.com",
)
assert pyicloud_service.params["dsid"] == "12345"
assert result == mock_photos_service
def test_photos_returns_cached_instance(
pyicloud_service: PyiCloudService,
) -> None:
"""Test photos property returns cached instance if already set."""
mock_photos_service = MagicMock()
pyicloud_service._photos = mock_photos_service
with patch.object(pyicloud_service, "_request_pcs_for_service"):
result: PhotosService = pyicloud_service.photos
assert result == mock_photos_service
def test_photos_raises_on_api_exception(
pyicloud_service: PyiCloudService,
) -> None:
"""Test photos property raises PyiCloudServiceUnavailable on API exception."""
with (
patch.object(
pyicloud_service,
"get_webservice_url",
side_effect=[
"https://photos.example.com",
"https://upload.example.com",
"https://shared.example.com",
],
),
patch(
"pyicloud.base.PhotosService",
side_effect=PyiCloudAPIResponseException("error"),
),
patch.object(pyicloud_service, "_request_pcs_for_service"),
):
pyicloud_service._photos = None
pyicloud_service.data = {"dsInfo": {"dsid": "12345"}}
with pytest.raises(
PyiCloudServiceUnavailable, match="Photos service not available"
):
_: PhotosService = pyicloud_service.photos
def test_calendar_returns_service(
pyicloud_service: PyiCloudService,
) -> None:
"""Test calendar property returns CalendarService instance."""
mock_calendar_service = MagicMock()
with (
patch.object(
pyicloud_service,
"get_webservice_url",
return_value="https://calendar.example.com",
),
patch(
"pyicloud.base.CalendarService",
return_value=mock_calendar_service,
) as mock_calendar_cls,
):
pyicloud_service._calendar = None
result: CalendarService = pyicloud_service.calendar
mock_calendar_cls.assert_called_once_with(
service_root="https://calendar.example.com",
session=pyicloud_service.session,
params=pyicloud_service.params,
)
assert result == mock_calendar_service
def test_calendar_returns_cached_instance(
pyicloud_service: PyiCloudService,
) -> None:
"""Test calendar property returns cached instance if already set."""
mock_calendar_service = MagicMock()
pyicloud_service._calendar = mock_calendar_service
result: CalendarService = pyicloud_service.calendar
assert result == mock_calendar_service
def test_calendar_raises_on_api_exception(
pyicloud_service: PyiCloudService,
) -> None:
"""Test calendar property raises PyiCloudServiceUnavailable on API exception."""
with (
patch.object(
pyicloud_service,
"get_webservice_url",
return_value="https://calendar.example.com",
),
patch(
"pyicloud.base.CalendarService",
side_effect=PyiCloudAPIResponseException("error"),
),
):
pyicloud_service._calendar = None
with pytest.raises(
PyiCloudServiceUnavailable,
match="Calendar service not available",
):
_: CalendarService = pyicloud_service.calendar
def test_contacts_returns_service(
pyicloud_service: PyiCloudService,
) -> None:
"""Test contacts property returns ContactsService instance."""
mock_contacts_service = MagicMock()
with (
patch.object(
pyicloud_service,
"get_webservice_url",
return_value="https://contacts.example.com",
),
patch(
"pyicloud.base.ContactsService",
return_value=mock_contacts_service,
) as mock_contacts_cls,
):
pyicloud_service._contacts = None
result: ContactsService = pyicloud_service.contacts
mock_contacts_cls.assert_called_once_with(
service_root="https://contacts.example.com",
session=pyicloud_service.session,
params=pyicloud_service.params,
)
assert result == mock_contacts_service
def test_contacts_returns_cached_instance(
pyicloud_service: PyiCloudService,
) -> None:
"""Test contacts property returns cached instance if already set."""
mock_contacts_service = MagicMock()
pyicloud_service._contacts = mock_contacts_service
result: ContactsService = pyicloud_service.contacts
assert result == mock_contacts_service
def test_contacts_raises_on_api_exception(
pyicloud_service: PyiCloudService,
) -> None:
"""Test contacts property raises PyiCloudServiceUnavailable on API exception."""
with (
patch.object(
pyicloud_service,
"get_webservice_url",
return_value="https://contacts.example.com",
),
patch(
"pyicloud.base.ContactsService",
side_effect=PyiCloudAPIResponseException("error"),
),
):
pyicloud_service._contacts = None
with pytest.raises(
PyiCloudServiceUnavailable,
match="Contacts service not available",
):
_: ContactsService = pyicloud_service.contacts
def test_reminders_returns_service(
pyicloud_service: PyiCloudService,
) -> None:
"""Test reminders property returns RemindersService instance."""
mock_reminders_service = MagicMock()
with (
patch.object(
pyicloud_service,
"get_webservice_url",
return_value="https://reminders.example.com",
),
patch(
"pyicloud.base.RemindersService",
return_value=mock_reminders_service,
) as mock_reminders_cls,
):
pyicloud_service._reminders = None
result: RemindersService = pyicloud_service.reminders
mock_reminders_cls.assert_called_once_with(
service_root="https://reminders.example.com",
session=pyicloud_service.session,
params=pyicloud_service.params,
)
assert result == mock_reminders_service
def test_reminders_returns_cached_instance(
pyicloud_service: PyiCloudService,
) -> None:
"""Test reminders property returns cached instance if already set."""
mock_reminders_service = MagicMock()
pyicloud_service._reminders = mock_reminders_service
result: RemindersService = pyicloud_service.reminders
assert result == mock_reminders_service
def test_reminders_raises_on_api_exception(
pyicloud_service: PyiCloudService,
) -> None:
"""Test reminders property raises PyiCloudServiceUnavailable on API exception."""
with (
patch.object(
pyicloud_service,
"get_webservice_url",
return_value="https://reminders.example.com",
),
patch(
"pyicloud.base.RemindersService",
side_effect=PyiCloudAPIResponseException("error"),
),
):
pyicloud_service._reminders = None
with pytest.raises(
PyiCloudServiceUnavailable,
match="Reminders service not available",
):
_ = pyicloud_service.reminders
|