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
|
"""Pytest configuration file for the pyicloud package."""
# pylint: disable=redefined-outer-name,protected-access
import os
import secrets
from typing import Any
from unittest.mock import MagicMock, mock_open, patch
import pytest
from requests.cookies import RequestsCookieJar
from pyicloud.base import PyiCloudService
from pyicloud.services.contacts import ContactsService
from pyicloud.services.drive import COOKIE_APPLE_WEBAUTH_VALIDATE
from pyicloud.services.hidemyemail import HideMyEmailService
from pyicloud.services.photos import BasePhotoLibrary, PhotoAsset
from pyicloud.session import PyiCloudSession
from tests import PyiCloudSessionMock
from tests.const import LOGIN_WORKING
BUILTINS_OPEN: str = "builtins.open"
EXAMPLE_DOMAIN: str = "https://example.com"
# pylint: disable=protected-access
# pylint: disable=redefined-outer-name
class FileSystemAccessError(Exception):
"""Raised when a test tries to access the file system."""
@pytest.fixture(autouse=True, scope="function")
def mock_file_open_write_fixture():
"""Mock the open function to prevent file system access."""
# Dictionary to store written data
written_data: dict[str, Any] = {}
def mock_file_open(filepath: str, mode="r", **_):
"""Mock file open function."""
if "w" in mode or "a" in mode:
# Writing or appending mode
def mock_write(content):
if filepath not in written_data:
written_data[filepath] = ""
if "a" in mode: # Append mode
written_data[filepath] += content
else: # Write mode
written_data[filepath] = content
mock_file = mock_open().return_value
mock_file.write = mock_write
return mock_file
if "r" in mode:
raise FileNotFoundError(f"No such file or directory: '{filepath}'")
raise ValueError(f"Unsupported mode: {mode}")
# Attach the written_data dictionary to the mock for access in tests
mock_file_open.written_data = written_data # type: ignore
return mock_file_open
@pytest.fixture(autouse=True, scope="function")
def mock_mkdir():
"""Mock the mkdir function to prevent file system access."""
mkdir = os.mkdir
def my_mkdir(path, *args, **kwargs):
if "python-test-results" not in path:
raise FileSystemAccessError(
f"You should not be creating directories in tests. {path}"
)
return mkdir(path, *args, **kwargs)
with patch("os.mkdir", my_mkdir) as mkdir_mock:
yield mkdir_mock
@pytest.fixture(autouse=True, scope="session")
def mock_open_fixture():
"""Mock the open function to prevent file system access."""
builtins_open = open
def my_open(path, *args, **kwargs):
if "python-test-results" not in path:
raise FileSystemAccessError(
f"You should not be opening files in tests. {path}"
)
return builtins_open(path, *args, **kwargs)
with patch(BUILTINS_OPEN, my_open) as open_mock:
yield open_mock
@pytest.fixture(autouse=True, scope="session")
def mock_os_open_fixture():
"""Mock the open function to prevent file system access."""
builtins_open = os.open
def my_open(path, *args, **kwargs):
if "python-test-results" not in path:
raise FileSystemAccessError(
f"You should not be opening files in tests. {path}"
)
return builtins_open(path, *args, **kwargs)
with patch("os.open", my_open) as open_mock:
yield open_mock
@pytest.fixture
def pyicloud_service() -> PyiCloudService:
"""Create a PyiCloudService instance with mocked authenticate method."""
with (
patch("pyicloud.PyiCloudService.authenticate") as mock_authenticate,
patch(
"pyicloud.PyiCloudService._setup_cookie_directory"
) as mock_setup_cookie_directory,
patch(BUILTINS_OPEN, new_callable=mock_open),
):
# Mock the authenticate method during initialization
mock_authenticate.return_value = None
mock_setup_cookie_directory.return_value = "/tmp/pyicloud/cookies"
service = PyiCloudService("test@example.com", secrets.token_hex(32))
return service
@pytest.fixture
def pyicloud_service_working(pyicloud_service: PyiCloudService) -> PyiCloudService:
"""Set the service to a working state."""
pyicloud_service.data = LOGIN_WORKING
pyicloud_service._webservices = LOGIN_WORKING["webservices"]
with patch(BUILTINS_OPEN, new_callable=mock_open):
pyicloud_service._session = PyiCloudSessionMock(
pyicloud_service,
"",
cookie_directory="",
)
pyicloud_service.session._data = {"session_token": "valid_token"}
check_pcs_consent = MagicMock(
return_value={
"isICDRSDisabled": False,
"isDeviceConsentedForPCS": True,
}
)
pyicloud_service._check_pcs_consent = check_pcs_consent
return pyicloud_service
@pytest.fixture
def pyicloud_session(pyicloud_service_working: PyiCloudService) -> PyiCloudSession:
"""Mock the PyiCloudSession class."""
pyicloud_service_working.session.cookies = MagicMock()
return pyicloud_service_working.session
@pytest.fixture
def mock_session() -> MagicMock:
"""Fixture to create a mock PyiCloudSession."""
return MagicMock(spec=PyiCloudSession)
@pytest.fixture
def contacts_service(mock_session: MagicMock) -> ContactsService:
"""Fixture to create a ContactsService instance."""
return ContactsService(
service_root=EXAMPLE_DOMAIN,
session=mock_session,
params={"test_param": "value"},
)
@pytest.fixture
def mock_photos_service() -> MagicMock:
"""Fixture for mocking PhotosService."""
service = MagicMock()
service.service_endpoint = EXAMPLE_DOMAIN
service.params = {"dsid": "12345"}
service.session = MagicMock()
return service
@pytest.fixture
def mock_photo_library(mock_photos_service: MagicMock) -> BasePhotoLibrary:
"""Fixture for mocking PhotoLibrary."""
return BasePhotoLibrary(
service=mock_photos_service,
asset_type=PhotoAsset,
)
@pytest.fixture
def hidemyemail_service(mock_session: MagicMock) -> HideMyEmailService:
"""Fixture for initializing HideMyEmailService."""
return HideMyEmailService(EXAMPLE_DOMAIN, mock_session, {"dsid": "12345"})
@pytest.fixture
def mock_service_with_cookies(
pyicloud_service_working: PyiCloudService,
) -> PyiCloudService:
"""Fixture to create a mock PyiCloudService with cookies."""
jar = RequestsCookieJar()
jar.set(COOKIE_APPLE_WEBAUTH_VALIDATE, "t=768y9u", domain="icloud.com", path="/")
# Attach a real CookieJar so code that calls `.cookies.get()` keeps working.
pyicloud_service_working.session.cookies = jar
return pyicloud_service_working
@pytest.fixture(autouse=True, scope="session")
def mock_thread():
"""Mock threading.Thread to prevent actual thread creation during tests."""
with patch("threading.Thread") as mock_thread_class:
yield mock_thread_class
|