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
|
"""
Test the PyiCloudService and PyiCloudSession classes."""
# pylint: disable=protected-access
from unittest.mock import MagicMock, mock_open, patch
import pytest
from requests import Response
from pyicloud.base import PyiCloudService, PyiCloudSession, b64_encode
from pyicloud.exceptions import (
PyiCloud2SARequiredException,
PyiCloudAPIResponseException,
PyiCloudFailedLoginException,
PyiCloudServiceNotActivatedException,
)
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.post") as mock_post_response,
patch.object(
pyicloud_service,
"_authenticate_with_token",
side_effect=[PyiCloudFailedLoginException, None],
) as mock_authenticate_with_token,
):
mock_post_response.return_value.json.side_effect = [
{
"salt": "U29tZVNhbHQ=",
"b": "U29tZUJ5dGVz",
"c": "TestC",
"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_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._get_webauthn_options = MagicMock(
return_value={
"fsaChallenge": {
"challenge": challenge, # base64url(fake_challenge)
"keyHandles": ["a2V5MQ", "a2V5Mg"], # base64url(fake_key_ids)
"rpId": rp_id,
}
}
)
# Simulated FIDO2 response
mock_response = MagicMock()
mock_response.client_data = b"client_data"
mock_response.signature = b"signature"
mock_response.authenticator_data = b"auth_data"
mock_response.user_handle = b"user_handle"
mock_response.credential_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.client_data),
"signatureData": b64_encode(mock_response.signature),
"authenticatorData": b64_encode(mock_response.authenticator_data),
"userHandle": b64_encode(mock_response.user_handle),
"credentialID": b64_encode(mock_response.credential_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",
}
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 = {"dsInfo": {"hsaVersion": 2}, "hsaChallengeRequired": False}
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("http.cookiejar.LWPCookieJar.save") as mock_save,
):
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(
pyicloud_service_working, "", 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()
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(
401, reason="Missing X-APPLE-WEBAUTH-TOKEN cookie"
)
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("ZONE_NOT_FOUND", reason="ServiceNotActivated")
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("ACCESS_DENIED", reason="ACCESS_DENIED")
|