"""Synology DSM tests.""" # pylint: disable=protected-access import pytest from synology_dsm.api.core.external_usb import SynoCoreExternalUSB from synology_dsm.api.core.security import SynoCoreSecurity from synology_dsm.api.core.share import SynoCoreShare from synology_dsm.api.core.system import SynoCoreSystem from synology_dsm.api.core.upgrade import SynoCoreUpgrade from synology_dsm.api.core.utilization import SynoCoreUtilization from synology_dsm.api.download_station import SynoDownloadStation from synology_dsm.api.dsm.information import SynoDSMInformation from synology_dsm.api.dsm.network import SynoDSMNetwork from synology_dsm.api.photos import SynoPhotos from synology_dsm.api.storage.storage import SynoStorage from synology_dsm.api.surveillance_station import SynoSurveillanceStation from synology_dsm.api.virtual_machine_manager import SynoVirtualMachineManager from synology_dsm.const import API_AUTH from synology_dsm.exceptions import SynologyDSMLogin2SARequiredException from . import ( VALID_HOST, VALID_HTTPS, VALID_OTP, VALID_PASSWORD, VALID_PORT, VALID_USER_2SA, SynologyDSMMock, ) from .api_data.dsm_7 import DSM_7_API_INFO from .const import DEVICE_TOKEN, SESSION_ID, SYNO_TOKEN class TestSynologyDSM7: """SynologyDSM 7 test cases.""" @pytest.mark.asyncio async def test_login(self, dsm_7): """Test login.""" assert await dsm_7.login() assert dsm_7.apis.get(API_AUTH) assert dsm_7._session_id == SESSION_ID assert dsm_7._syno_token == SYNO_TOKEN assert dsm_7.device_token is None assert dsm_7.apis == DSM_7_API_INFO["data"] assert isinstance(dsm_7.download_station, SynoDownloadStation) assert isinstance(dsm_7.external_usb, SynoCoreExternalUSB) assert isinstance(dsm_7.information, SynoDSMInformation) assert isinstance(dsm_7.network, SynoDSMNetwork) assert isinstance(dsm_7.photos, SynoPhotos) assert isinstance(dsm_7.security, SynoCoreSecurity) assert isinstance(dsm_7.share, SynoCoreShare) assert isinstance(dsm_7.storage, SynoStorage) assert isinstance(dsm_7.surveillance_station, SynoSurveillanceStation) assert isinstance(dsm_7.system, SynoCoreSystem) assert isinstance(dsm_7.upgrade, SynoCoreUpgrade) assert isinstance(dsm_7.utilisation, SynoCoreUtilization) assert isinstance(dsm_7.virtual_machine_manager, SynoVirtualMachineManager) @pytest.mark.asyncio async def test_login_2sa(self): """Test login with 2SA.""" dsm_7 = SynologyDSMMock( None, VALID_HOST, VALID_PORT, VALID_USER_2SA, VALID_PASSWORD, VALID_HTTPS, ) dsm_7.dsm_version = 7 with pytest.raises(SynologyDSMLogin2SARequiredException) as error: await dsm_7.login() error_value = error.value.args[0] assert error_value["api"] == "SYNO.API.Auth" assert error_value["code"] == 403 assert error_value["reason"] == "One time password not specified" assert ( error_value["details"] == "Two-step authentication required for account: valid_user_2sa" ) assert await dsm_7.login(VALID_OTP) assert dsm_7._session_id == SESSION_ID assert dsm_7._syno_token == SYNO_TOKEN assert dsm_7._device_token == DEVICE_TOKEN assert dsm_7.device_token == DEVICE_TOKEN @pytest.mark.asyncio async def test_information(self, dsm_7): """Test information.""" assert await dsm_7.login() assert dsm_7.information await dsm_7.information.update() assert dsm_7.information.model == "DS918+" assert dsm_7.information.ram == 4096 assert dsm_7.information.serial == "1920PDN001501" assert dsm_7.information.temperature == 40 assert not dsm_7.information.temperature_warn assert dsm_7.information.uptime == 155084 assert dsm_7.information.version == "24922" assert dsm_7.information.version_string == "DSM 7.0-41222" assert dsm_7.information.awesome_version == "7.0.0" @pytest.mark.asyncio async def test_external_usb(self, dsm_7): """Test external USB storage devices.""" assert await dsm_7.login() assert dsm_7.external_usb await dsm_7.external_usb.update() devices = dsm_7.external_usb.get_devices assert len(devices) == 7 for device in dsm_7.external_usb.get_devices.values(): assert device.device_name assert device.device_type assert device.device_status assert device.device_size_total() assert device.device_size_total(True) assert device.device_manufacturer assert device.device_product_name assert device.device_formatable assert not device.device_progress for partition in device.device_partitions.values(): assert partition.name_id assert partition.partition_title assert partition.fstype assert partition.status if partition.is_mounted: assert partition.share_name if partition.is_supported: assert partition.filesystem assert partition.partition_size_used(True) assert partition.partition_size_total(True) device = dsm_7.external_usb.get_device("usb1") assert device.device_name == "USB Disk 1" assert device.device_type == "usbDisk" assert device.device_status == "normal" assert device.device_size_total() == 127999672320 assert device.device_size_total(True) == "119.2Gb" assert device.device_manufacturer == "PNY" assert device.device_product_name == "Flash Drive" assert device.device_formatable assert device.device_progress == "" for partition in device.device_partitions.values(): assert partition.name_id assert partition.partition_title assert partition.fstype assert partition.status if partition.is_mounted: assert partition.share_name if partition.is_supported: assert partition.filesystem assert partition.partition_size_used(human_readable=True) assert partition.partition_size_total(human_readable=True) partition = device.get_device_partition("usb1p1") assert partition.share_name == "usbshare1-1" assert partition.filesystem == "ntfs" partition = device.get_device_partition("usb1p2") assert partition.share_name == "usbshare1-2" assert partition.filesystem == "FAT32" assert partition.partition_size_total(False) == 1073741824.0 # Unformatted device partition partition = dsm_7.external_usb.get_device("usb8").get_device_partition("usb8") assert partition assert not partition.is_mounted assert not partition.is_supported assert partition.partition_size_total(False) is None assert partition.partition_size_used(False) is None assert partition.partition_percentage_used is None @pytest.mark.asyncio async def test_login_2sa_new_session(self): """Test login with 2SA and a new session with granted device.""" dsm_7 = SynologyDSMMock( None, VALID_HOST, VALID_PORT, VALID_USER_2SA, VALID_PASSWORD, VALID_HTTPS, device_token=DEVICE_TOKEN, ) dsm_7.dsm_version = 7 assert await dsm_7.login() assert dsm_7._session_id == SESSION_ID assert dsm_7._syno_token == SYNO_TOKEN assert dsm_7._device_token == DEVICE_TOKEN assert dsm_7.device_token == DEVICE_TOKEN @pytest.mark.asyncio async def test_upgrade(self, dsm_7): """Test upgrade.""" assert await dsm_7.login() assert dsm_7.upgrade await dsm_7.upgrade.update() assert dsm_7.upgrade.update_available assert dsm_7.upgrade.available_version == "7.0.1-42218 Update 3" assert dsm_7.upgrade.reboot_needed == "now" assert dsm_7.upgrade.service_restarts == "some" assert dsm_7.upgrade.available_version_details == { "buildnumber": 42218, "major": 7, "micro": 1, "minor": 0, "nano": 3, "os_name": "DSM", } @pytest.mark.asyncio async def test_photos(self, dsm_7): """Test photos.""" assert await dsm_7.login() assert dsm_7.photos albums = await dsm_7.photos.get_albums() assert albums assert len(albums) == 3 assert albums[0].album_id == 4 assert albums[0].name == "Album1" assert albums[0].item_count == 3 assert albums[0].passphrase == "" assert albums[1].album_id == 1 assert albums[1].name == "Album2" assert albums[1].item_count == 1 assert albums[1].passphrase == "" assert albums[2].album_id == 3 assert albums[2].name == "Album3" assert albums[2].item_count == 1 assert albums[2].passphrase == "NiXlv1i2N" items = await dsm_7.photos.get_items_from_album(albums[0]) assert items assert len(items) == 3 assert items[0].file_name == "20221115_185642.jpg" assert items[0].thumbnail_cache_key == "29807_1668560967" assert items[0].thumbnail_size == "xl" assert items[0].passphrase == "" assert items[1].file_name == "20221115_185643.jpg" assert items[1].thumbnail_cache_key == "29808_1668560967" assert items[1].thumbnail_size == "m" assert items[1].passphrase == "" assert items[2].file_name == "20221115_185644.jpg" assert items[2].thumbnail_cache_key == "29809_1668560967" assert items[2].thumbnail_size == "sm" assert items[2].passphrase == "" thumb_url = await dsm_7.photos.get_item_thumbnail_url(items[0]) assert thumb_url assert thumb_url == ( f"https://{VALID_HOST}:{VALID_PORT}/webapi/entry.cgi?" "id=29807&cache_key=29807_1668560967&size=xl&type=unit" "&api=SYNO.Foto.Thumbnail&version=2&method=get" "&_sid=session_id&SynoToken=Sy%C3%B10_T0k%E2%82%AC%C3%B1" ) thumb_url = await dsm_7.photos.get_item_thumbnail_url(items[1]) assert thumb_url assert thumb_url == ( f"https://{VALID_HOST}:{VALID_PORT}/webapi/entry.cgi?" "id=29808&cache_key=29808_1668560967&size=m&type=unit" "&api=SYNO.FotoTeam.Thumbnail&version=2&method=get" "&_sid=session_id&SynoToken=Sy%C3%B10_T0k%E2%82%AC%C3%B1" ) items = await dsm_7.photos.get_items_from_album(albums[2]) assert items assert len(items) == 1 assert items[0].file_name == "20221115_185645.jpg" assert items[0].thumbnail_cache_key == "29810_1668560967" assert items[0].thumbnail_size == "xl" assert items[0].passphrase == "NiXlv1i2N" thumb_url = await dsm_7.photos.get_item_thumbnail_url(items[0]) assert thumb_url assert thumb_url == ( f"https://{VALID_HOST}:{VALID_PORT}/webapi/entry.cgi?" "id=29807&cache_key=29810_1668560967&size=xl&type=unit" "&passphrase=NiXlv1i2N&api=SYNO.Foto.Thumbnail&version=2&method=get" "&_sid=session_id&SynoToken=Sy%C3%B10_T0k%E2%82%AC%C3%B1" ) items = await dsm_7.photos.get_items_from_search(albums[0]) assert items assert len(items) == 2 assert items[0].file_name == "search_1.jpg" assert items[0].thumbnail_cache_key == "12340_1668560967" assert items[1].file_name == "search_2.jpg" assert items[1].thumbnail_cache_key == "12341_1668560967" items = await dsm_7.photos.get_items_from_shared_space() assert items assert len(items) == 3 assert items[0].file_name == "shared_1.jpg" assert items[0].thumbnail_cache_key == "77_1628323785" assert items[1].file_name == "shared_2.jpg" assert items[1].thumbnail_cache_key == "490_1628323817" assert items[2].file_name == "shared_3.jpg" assert items[2].thumbnail_cache_key == "96_1628323786" @pytest.mark.asyncio async def test_file_station(self, dsm_7): """Test File Station.""" assert await dsm_7.login() assert dsm_7.file folders = await dsm_7.file.get_shared_folders() assert folders assert len(folders) == 2 assert folders[0].name == "backup" assert folders[0].path == "/backup" assert folders[0].is_dir is True assert folders[0].additional.mount_point_type == "" assert folders[0].additional.owner.gid == 0 assert folders[0].additional.owner.group == "root" assert folders[0].additional.owner.uid == 0 assert folders[0].additional.owner.user == "root" assert isinstance(folders[0].additional.perm.acl, dict) assert isinstance(folders[0].additional.perm.adv_right, dict) assert folders[0].additional.perm.acl_enable is True assert folders[0].additional.perm.is_acl_mode is True assert folders[0].additional.perm.is_share_readonly is False assert folders[0].additional.perm.posix == 777 assert folders[0].additional.perm.share_right == "RW" assert folders[0].additional.volume_status.freespace == 1553335107584 assert folders[0].additional.volume_status.totalspace == 3821146505216 assert folders[0].additional.volume_status.readonly is False assert folders[1].name == "home" assert folders[1].path == "/home" assert folders[1].is_dir is True assert folders[1].additional.mount_point_type == "" assert folders[1].additional.owner.gid == 100 assert folders[1].additional.owner.group == "users" assert folders[1].additional.owner.uid == 1046 assert folders[1].additional.owner.user == "hass" assert isinstance(folders[1].additional.perm.acl, dict) assert isinstance(folders[1].additional.perm.adv_right, dict) assert folders[1].additional.perm.acl_enable is True assert folders[1].additional.perm.is_acl_mode is True assert folders[1].additional.perm.is_share_readonly is False assert folders[1].additional.perm.posix == 777 assert folders[1].additional.perm.share_right == "RW" assert folders[1].additional.volume_status.freespace == 1553335107584 assert folders[1].additional.volume_status.totalspace == 3821146505216 assert folders[1].additional.volume_status.readonly is False files = await dsm_7.file.get_files("/home") assert files assert len(files) == 2 assert files[0].name == "Photos" assert files[0].path == "/home/Photos" assert files[0].is_dir is True assert files[0].additional.mount_point_type == "" assert files[0].additional.owner.gid == 105733 assert files[0].additional.owner.group == "SynologyPhotos" assert files[0].additional.owner.uid == 1046 assert files[0].additional.owner.user == "hass" assert isinstance(files[0].additional.perm.acl, dict) assert files[0].additional.perm.is_acl_mode is True assert files[0].additional.perm.posix == 711 assert files[0].additional.real_path == "/volume1/homes/hass/Photos" assert files[0].additional.size == 50 assert files[0].additional.time.atime == 1735700476 assert files[0].additional.time.ctime == 1723653464 assert files[0].additional.time.crtime == 1723653032 assert files[0].additional.time.mtime == 1723653464 assert files[0].additional.type == "" assert files[1].name == "3e57d06c.tar" assert files[1].path == "/home/3e57d06c.tar" assert files[1].is_dir is False assert files[1].additional.mount_point_type == "" assert files[1].additional.owner.gid == 100 assert files[1].additional.owner.group == "users" assert files[1].additional.owner.uid == 1046 assert files[1].additional.owner.user == "hass" assert isinstance(files[1].additional.perm.acl, dict) assert files[1].additional.perm.is_acl_mode is True assert files[1].additional.perm.posix == 711 assert files[1].additional.real_path == "/volume1/homes/hass/3e57d06c.tar" assert files[1].additional.size == 1660753920 assert files[1].additional.time.atime == 1736105132 assert files[1].additional.time.ctime == 1736105132 assert files[1].additional.time.crtime == 1736105128 assert files[1].additional.time.mtime == 1736105132 assert files[1].additional.type == "TAR" @pytest.mark.asyncio async def test_virtual_machine_manager(self, dsm_7): """Test vmm.""" assert await dsm_7.login() assert dsm_7.virtual_machine_manager await dsm_7.virtual_machine_manager.update() guests = dsm_7.virtual_machine_manager.get_all_guests() assert guests assert len(guests) == 2 assert guests[0].autorun is False assert guests[0].description == "vDSM test" assert guests[0].guest_id == "a39d0628-380e-42f8-8cb6-a00d6b930fa0" assert guests[0].name == "vdsm" assert guests[0].status == "shutdown" assert guests[0].host_cpu_usage == 0 assert guests[0].host_ram_usage == 0 assert guests[0].vcpu_num == 1 assert guests[0].vram_size == 1048576 assert guests[1].autorun is True assert guests[1].description == "" assert guests[1].guest_id == "2b4ec8c8-2bec-4daa-b36d-1a47b639254f" assert guests[1].name == "lnx_test" assert guests[1].status == "running" assert guests[1].host_cpu_usage == 25 assert guests[1].host_ram_usage == 1169544 assert guests[1].vcpu_num == 1 assert guests[1].vram_size == 1048576