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
|
"""Drive service tests."""
import json
from typing import Optional
from unittest.mock import ANY, Mock, patch
import pytest
from pyicloud.base import PyiCloudService
from pyicloud.const import CONTENT_TYPE, CONTENT_TYPE_TEXT
from pyicloud.exceptions import PyiCloudAPIResponseException
from pyicloud.services.drive import (
CLOUD_DOCS_ZONE,
NODE_TRASH,
DriveNode,
DriveService,
)
def test_root(pyicloud_service_working: PyiCloudService) -> None:
"""Test the root folder."""
drive: DriveService = pyicloud_service_working.drive
# root name is now extracted from drivewsid.
assert drive.name == "root"
assert drive.type == "folder"
assert drive.size is None
assert drive.date_changed is None
assert drive.date_modified is None
assert drive.date_last_open is None
assert drive.dir() == ["Keynote", "Numbers", "Pages", "Preview", "pyiCloud"]
def test_trash(pyicloud_service_working: PyiCloudService) -> None:
"""Test the trash folder."""
trash: DriveNode = pyicloud_service_working.drive.trash
assert trash.name == NODE_TRASH
assert trash.type == DriveNode.TYPE_TRASH
assert trash.size is None
assert trash.date_changed is None
assert trash.date_modified is None
assert trash.date_last_open is None
assert trash.dir() == [
"dead-file.download",
"test_create_folder",
"test_delete_forever_and_ever",
"test_files_1",
"test_random_uuid",
"test12345",
]
def test_trash_recover(pyicloud_service_working: PyiCloudService) -> None:
"""Test recovering a file from the Trash."""
trash_node = pyicloud_service_working.drive.trash["test_random_uuid"]
assert trash_node is not None
recover_result = trash_node.recover()
recover_result_items = recover_result["items"][0]
assert recover_result_items["status"] == "OK"
assert recover_result_items["parentId"] == "FOLDER::com.apple.CloudDocs::root"
assert recover_result_items["name"] == "test_random_uuid"
def test_trash_delete_forever(pyicloud_service_working: PyiCloudService) -> None:
"""Test permanently deleting a file from the Trash."""
node = pyicloud_service_working.drive.trash["test_delete_forever_and_ever"]
assert node is not None, "Expected a valid trash node before deleting forever."
recover_result = node.delete_forever()
recover_result_items = recover_result["items"][0]
assert recover_result_items["status"] == "OK"
assert (
recover_result_items["parentId"]
== "FOLDER::com.apple.CloudDocs::43D7C666-6E6E-4522-8999-0B519C3A1F4B"
)
assert recover_result_items["name"] == "test_delete_forever_and_ever"
def test_folder_app(pyicloud_service_working: PyiCloudService) -> None:
"""Test the /Preview folder."""
folder: Optional[DriveNode] = pyicloud_service_working.drive["Preview"]
assert folder
assert folder.name == "Preview"
assert folder.type == "app_library"
assert folder.size is None
assert folder.date_changed is None
assert folder.date_modified is None
assert folder.date_last_open is None
with pytest.raises(KeyError, match="No items in folder, status: ID_INVALID"):
folder.dir()
def test_folder_not_exists(pyicloud_service_working: PyiCloudService) -> None:
"""Test the /not_exists folder."""
with pytest.raises(KeyError, match="No child named 'not_exists' exists"):
pyicloud_service_working.drive["not_exists"] # pylint: disable=pointless-statement
def test_folder(pyicloud_service_working: PyiCloudService) -> None:
"""Test the /pyiCloud folder."""
folder: Optional[DriveNode] = pyicloud_service_working.drive["pyiCloud"]
assert folder
assert folder.name == "pyiCloud"
assert folder.type == "folder"
assert folder.size is None
assert folder.date_changed is None
assert folder.date_modified is None
assert folder.date_last_open is None
assert folder.dir() == ["Test"]
def test_subfolder(pyicloud_service_working: PyiCloudService) -> None:
"""Test the /pyiCloud/Test folder."""
parent_folder: Optional[DriveNode] = pyicloud_service_working.drive["pyiCloud"]
assert parent_folder is not None, "Expected to find 'pyiCloud' folder."
folder: Optional[DriveNode] = parent_folder["Test"]
assert folder
assert folder.name == "Test"
assert folder.type == "folder"
assert folder.size is None
assert folder.date_changed is None
assert folder.date_modified is None
assert folder.date_last_open is None
assert folder.dir() == ["Document scanneĢ 2.pdf", "Scanned document 1.pdf"]
def test_subfolder_file(pyicloud_service_working: PyiCloudService) -> None:
"""Test the /pyiCloud/Test/Scanned document 1.pdf file."""
drive: Optional[DriveNode] = pyicloud_service_working.drive["pyiCloud"]
assert drive
folder: Optional[DriveNode] = drive["Test"]
assert folder
file_test: Optional[DriveNode] = folder["Scanned document 1.pdf"]
assert file_test
assert file_test.name == "Scanned document 1.pdf"
assert file_test.type == "file"
assert file_test.size == 21644358
assert str(file_test.date_changed) == "2020-05-03 00:16:17"
assert str(file_test.date_modified) == "2020-05-03 00:15:17"
assert str(file_test.date_last_open) == "2020-05-03 00:24:25"
with pytest.raises(NotADirectoryError):
file_test.dir()
def test_file_open(pyicloud_service_working: PyiCloudService) -> None:
"""Test the /pyiCloud/Test/Scanned document 1.pdf file open."""
drive: Optional[DriveNode] = pyicloud_service_working.drive["pyiCloud"]
assert drive
folder: Optional[DriveNode] = drive["Test"]
assert folder
file_test: Optional[DriveNode] = folder["Scanned document 1.pdf"]
assert file_test
with file_test.open(stream=True) as response:
assert response.raw
def test_get_node_data(pyicloud_service_working: PyiCloudService) -> None:
"""Test retrieving node data."""
drive: DriveService = pyicloud_service_working.drive
mock_response = {"drivewsid": "test_id", "name": "Test Node"}
with patch.object(
drive.session, "post", return_value=Mock(ok=True, json=lambda: [mock_response])
) as mock_post:
node_data = drive.get_node_data("test_id")
assert node_data == mock_response
mock_post.assert_called_once_with(
drive.service_root + "/retrieveItemDetailsInFolders",
params=drive.params,
data=json.dumps([{"drivewsid": "test_id", "partialData": False}]),
)
def test_get_file(pyicloud_service_working: PyiCloudService) -> None:
"""Test retrieving a file."""
drive: DriveService = pyicloud_service_working.drive
mock_response = {"data_token": {"url": "https://example.com/file"}}
with patch.object(
drive.session,
"get",
side_effect=[
Mock(ok=True, json=lambda: mock_response),
Mock(ok=True, content=b"file content"),
],
) as mock_get:
file_response = drive.get_file("file_id")
assert file_response.content == b"file content"
mock_get.assert_any_call(
drive._document_root + f"/ws/{CLOUD_DOCS_ZONE}/download/by_id", # pylint: disable=protected-access
params={**drive.params, "document_id": "file_id"},
)
mock_get.assert_any_call("https://example.com/file", params=drive.params)
def test_create_folders(pyicloud_service_working: PyiCloudService) -> None:
"""Test creating a folder."""
drive: DriveService = pyicloud_service_working.drive
mock_response = {"folders": [{"name": "New Folder"}]}
with patch.object(
drive.session, "post", return_value=Mock(ok=True, json=lambda: mock_response)
) as mock_post:
response = drive.create_folders("parent_id", "New Folder")
assert response == mock_response
mock_post.assert_called_once_with(
drive.service_root + "/createFolders",
params=drive.params,
headers={CONTENT_TYPE: CONTENT_TYPE_TEXT},
data=ANY,
)
def test_delete_items(pyicloud_service_working: PyiCloudService) -> None:
"""Test deleting an item."""
drive: DriveService = pyicloud_service_working.drive
mock_response = {"status": "OK"}
with patch.object(
drive.session, "post", return_value=Mock(ok=True, json=lambda: mock_response)
) as mock_post:
response = drive.delete_items("node_id", "etag")
assert response == mock_response
mock_post.assert_called_once_with(
drive.service_root + "/deleteItems",
params=drive.params,
data=json.dumps(
{
"items": [
{
"drivewsid": "node_id",
"etag": "etag",
"clientId": drive.params["clientId"],
},
]
}
),
)
def test_rename_items(pyicloud_service_working: PyiCloudService) -> None:
"""Test renaming an item."""
drive: DriveService = pyicloud_service_working.drive
mock_response = {"status": "OK"}
with patch.object(
drive.session,
"post",
return_value=Mock(ok=True, json=lambda: mock_response),
) as mock_post:
response = drive.rename_items("node_id", "etag", "New Name")
assert response == mock_response
mock_post.assert_called_once_with(
drive.service_root + "/renameItems",
params=drive.params,
data=json.dumps(
{
"items": [
{"drivewsid": "node_id", "etag": "etag", "name": "New Name"},
]
}
),
)
def test_move_items_to_trash(pyicloud_service_working: PyiCloudService) -> None:
"""Test moving an item to trash."""
drive: DriveService = pyicloud_service_working.drive
mock_response = {"status": "OK"}
with patch.object(
drive.session, "post", return_value=Mock(ok=True, json=lambda: mock_response)
) as mock_post:
response = drive.move_items_to_trash("node_id", "etag")
assert response == mock_response
mock_post.assert_called_once_with(
drive.service_root + "/moveItemsToTrash",
params=drive.params,
data=json.dumps(
{
"items": [
{"drivewsid": "node_id", "etag": "etag", "clientId": "node_id"},
]
}
),
)
def test_recover_items_from_trash(pyicloud_service_working: PyiCloudService) -> None:
"""Test recovering an item from trash."""
drive: DriveService = pyicloud_service_working.drive
mock_response = {"status": "OK"}
with patch.object(
drive.session, "post", return_value=Mock(ok=True, json=lambda: mock_response)
) as mock_post:
response = drive.recover_items_from_trash("node_id", "etag")
assert response == mock_response
mock_post.assert_called_once_with(
drive.service_root + "/putBackItemsFromTrash",
params=drive.params,
data=json.dumps(
{
"items": [
{"drivewsid": "node_id", "etag": "etag"},
]
}
),
)
def test_delete_forever_from_trash(pyicloud_service_working: PyiCloudService) -> None:
"""Test permanently deleting an item from trash."""
drive: DriveService = pyicloud_service_working.drive
mock_response = {"status": "OK"}
with patch.object(
drive.session, "post", return_value=Mock(ok=True, json=lambda: mock_response)
) as mock_post:
response = drive.delete_forever_from_trash("node_id", "etag")
assert response == mock_response
mock_post.assert_called_once_with(
drive.service_root + "/deleteItems",
params=drive.params,
data=json.dumps(
{
"items": [
{"drivewsid": "node_id", "etag": "etag"},
]
}
),
)
def test_get_upload_contentws_url_success(
mock_service_with_cookies: PyiCloudService,
) -> None:
"""Test successful retrieval of upload contentWS URL."""
drive: DriveService = mock_service_with_cookies.drive
mock_file = Mock()
mock_file.name = "test_file.txt"
mock_file.tell = Mock(side_effect=[0, 100, 0]) # Mock file size as 100 bytes
mock_response = [
{"document_id": "mock_document_id", "url": "https://example.com/upload"}
]
with (
patch.object(
drive.session,
"post",
return_value=Mock(ok=True, json=lambda: mock_response),
) as mock_post,
patch("mimetypes.guess_type", return_value=("text/plain", None)),
):
document_id, url = drive._get_upload_contentws_url(mock_file) # pylint: disable=protected-access
assert document_id == "mock_document_id"
assert url == "https://example.com/upload"
mock_post.assert_called_once_with(
drive._document_root + f"/ws/{CLOUD_DOCS_ZONE}/upload/web", # pylint: disable=protected-access
params=ANY,
headers={CONTENT_TYPE: CONTENT_TYPE_TEXT},
data=json.dumps(
{
"filename": "test_file.txt",
"type": "FILE",
"content_type": "text/plain",
"size": 100,
}
),
)
def test_get_upload_contentws_url_no_content_type(
mock_service_with_cookies: PyiCloudService,
) -> None:
"""Test retrieval of upload contentWS URL when content type is None."""
drive: DriveService = mock_service_with_cookies.drive
mock_file = Mock()
mock_file.name = "test_file.unknown"
mock_file.tell = Mock(side_effect=[0, 200, 0]) # Mock file size as 200 bytes
mock_response = [
{"document_id": "mock_document_id", "url": "https://example.com/upload"}
]
with (
patch.object(
drive.session,
"post",
return_value=Mock(ok=True, json=lambda: mock_response),
) as mock_post,
patch("mimetypes.guess_type", return_value=(None, None)),
):
document_id, url = drive._get_upload_contentws_url(mock_file) # pylint: disable=protected-access
assert document_id == "mock_document_id"
assert url == "https://example.com/upload"
mock_post.assert_called_once_with(
drive._document_root + f"/ws/{CLOUD_DOCS_ZONE}/upload/web", # pylint: disable=protected-access
params=ANY,
headers={CONTENT_TYPE: CONTENT_TYPE_TEXT},
data=json.dumps(
{
"filename": "test_file.unknown",
"type": "FILE",
"content_type": "",
"size": 200,
}
),
)
def test_get_upload_contentws_url_error_response(
mock_service_with_cookies: PyiCloudService,
) -> None:
"""Test retrieval of upload contentWS URL with an error response."""
drive: DriveService = mock_service_with_cookies.drive
mock_file = Mock()
mock_file.name = "test_file.txt"
mock_file.tell = Mock(side_effect=[0, 300, 0]) # Mock file size as 300 bytes
with (
patch.object(
drive.session, "post", return_value=Mock(ok=False, reason="Bad Request")
) as mock_post,
patch("mimetypes.guess_type", return_value=("text/plain", None)),
):
with pytest.raises(PyiCloudAPIResponseException, match="Bad Request"):
drive._get_upload_contentws_url(mock_file) # pylint: disable=protected-access
mock_post.assert_called_once_with(
drive._document_root + f"/ws/{CLOUD_DOCS_ZONE}/upload/web", # pylint: disable=protected-access
params=ANY,
headers={CONTENT_TYPE: CONTENT_TYPE_TEXT},
data=json.dumps(
{
"filename": "test_file.txt",
"type": "FILE",
"content_type": "text/plain",
"size": 300,
}
),
)
def test_get_upload_contentws_url_invalid_response_format(
mock_service_with_cookies: PyiCloudService,
) -> None:
"""Test retrieval of upload contentWS URL with an invalid response format."""
drive: DriveService = mock_service_with_cookies.drive
mock_file = Mock()
mock_file.name = "test_file.txt"
mock_file.tell = Mock(side_effect=[0, 400, 0]) # Mock file size as 400 bytes
mock_response = [] # Invalid response format
with (
patch.object(
drive.session,
"post",
return_value=Mock(ok=True, json=lambda: mock_response),
) as mock_post,
patch("mimetypes.guess_type", return_value=("text/plain", None)),
):
with pytest.raises(IndexError):
drive._get_upload_contentws_url(mock_file) # pylint: disable=protected-access
mock_post.assert_called_once_with(
drive._document_root + f"/ws/{CLOUD_DOCS_ZONE}/upload/web", # pylint: disable=protected-access
params=ANY,
headers={CONTENT_TYPE: CONTENT_TYPE_TEXT},
data=json.dumps(
{
"filename": "test_file.txt",
"type": "FILE",
"content_type": "text/plain",
"size": 400,
}
),
)
def test_send_file_success(mock_service_with_cookies: PyiCloudService) -> None:
"""Test successfully sending a file to iCloud Drive."""
drive: DriveService = mock_service_with_cookies.drive
mock_file = Mock()
mock_file.name = "test_file.txt"
mock_file.tell = Mock(side_effect=[0, 100, 0]) # Mock file size as 100 bytes
mock_upload_url_response = [
{"document_id": "mock_document_id", "url": "https://example.com/upload"}
]
mock_upload_response = {
"singleFile": {
"fileChecksum": "mock_checksum",
"wrappingKey": "mock_key",
"referenceChecksum": "mock_reference",
"size": 100,
}
}
mock_update_response = {"status": "OK"}
with (
patch.object(
drive.session,
"post",
side_effect=[
Mock(
ok=True, json=lambda: mock_upload_url_response
), # _get_upload_contentws_url
Mock(ok=True, json=lambda: mock_upload_response), # Upload file
Mock(ok=True, json=lambda: mock_update_response), # _update_contentws
],
) as mock_post,
patch("mimetypes.guess_type", return_value=("text/plain", None)),
):
drive.send_file("mock_folder_id", mock_file)
# Assert _get_upload_contentws_url call
mock_post.assert_any_call(
drive._document_root + f"/ws/{CLOUD_DOCS_ZONE}/upload/web", # pylint: disable=protected-access
params=ANY,
headers={CONTENT_TYPE: CONTENT_TYPE_TEXT},
data=json.dumps(
{
"filename": "test_file.txt",
"type": "FILE",
"content_type": "text/plain",
"size": 100,
}
),
)
# Assert file upload call
mock_post.assert_any_call(
"https://example.com/upload",
files={"test_file.txt": mock_file},
)
# Assert _update_contentws call
mock_post.assert_any_call(
drive._document_root + f"/ws/{CLOUD_DOCS_ZONE}/update/documents", # pylint: disable=protected-access
params=drive.params,
headers={CONTENT_TYPE: CONTENT_TYPE_TEXT},
data=ANY,
)
def test_send_file_upload_error(mock_service_with_cookies: PyiCloudService) -> None:
"""Test sending a file to iCloud Drive with an upload error."""
drive: DriveService = mock_service_with_cookies.drive
mock_file = Mock()
mock_file.name = "test_file.txt"
mock_file.tell = Mock(side_effect=[0, 100, 0]) # Mock file size as 100 bytes
mock_upload_url_response = [
{"document_id": "mock_document_id", "url": "https://example.com/upload"}
]
with (
patch.object(
drive.session,
"post",
side_effect=[
Mock(
ok=True, json=lambda: mock_upload_url_response
), # _get_upload_contentws_url
Mock(ok=False, reason="Upload Failed"), # Upload file
],
) as mock_post,
patch("mimetypes.guess_type", return_value=("text/plain", None)),
):
with pytest.raises(PyiCloudAPIResponseException, match="Upload Failed"):
drive.send_file("mock_folder_id", mock_file)
# Assert _get_upload_contentws_url call
mock_post.assert_any_call(
drive._document_root + f"/ws/{CLOUD_DOCS_ZONE}/upload/web", # pylint: disable=protected-access
params=ANY,
headers={CONTENT_TYPE: CONTENT_TYPE_TEXT},
data=json.dumps(
{
"filename": "test_file.txt",
"type": "FILE",
"content_type": "text/plain",
"size": 100,
}
),
)
# Assert file upload call
mock_post.assert_any_call(
"https://example.com/upload",
files={"test_file.txt": mock_file},
)
def test_send_file_update_error(mock_service_with_cookies: PyiCloudService) -> None:
"""Test sending a file to iCloud Drive with an update error."""
drive: DriveService = mock_service_with_cookies.drive
mock_file = Mock()
mock_file.name = "test_file.txt"
mock_file.tell = Mock(side_effect=[0, 100, 0]) # Mock file size as 100 bytes
mock_upload_url_response = [
{"document_id": "mock_document_id", "url": "https://example.com/upload"}
]
mock_upload_response = {
"singleFile": {
"fileChecksum": "mock_checksum",
"wrappingKey": "mock_key",
"referenceChecksum": "mock_reference",
"size": 100,
}
}
with (
patch.object(
drive.session,
"post",
side_effect=[
Mock(
ok=True, json=lambda: mock_upload_url_response
), # _get_upload_contentws_url
Mock(ok=True, json=lambda: mock_upload_response), # Upload file
Mock(ok=False, reason="Update Failed"), # _update_contentws
],
) as mock_post,
patch("mimetypes.guess_type", return_value=("text/plain", None)),
):
with pytest.raises(PyiCloudAPIResponseException, match="Update Failed"):
drive.send_file("mock_folder_id", mock_file)
# Assert _get_upload_contentws_url call
mock_post.assert_any_call(
drive._document_root + f"/ws/{CLOUD_DOCS_ZONE}/upload/web", # pylint: disable=protected-access
params=ANY,
headers={CONTENT_TYPE: CONTENT_TYPE_TEXT},
data=json.dumps(
{
"filename": "test_file.txt",
"type": "FILE",
"content_type": "text/plain",
"size": 100,
}
),
)
# Assert file upload call
mock_post.assert_any_call(
"https://example.com/upload",
files={"test_file.txt": mock_file},
)
# Assert _update_contentws call
mock_post.assert_any_call(
drive._document_root + f"/ws/{CLOUD_DOCS_ZONE}/update/documents", # pylint: disable=protected-access
params=drive.params,
headers={CONTENT_TYPE: CONTENT_TYPE_TEXT},
data=ANY,
)
|