Skip to content

Returns unmodified data first, use human_readable=True if needed #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Quentame merged 1 commit into from
May 1, 2020
Merged

Returns unmodified data first, use human_readable=True if needed #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions synology_dsm/api/core/utilization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def memory_real_usage(self):
return str(self._data["memory"]["real_usage"])
return None

def memory_size(self, human_readable=True):
def memory_size(self, human_readable=False):
"""Total memory size of Synology DSM."""
if self.memory:
# Memory is actually returned in KB's so multiply before converting
Expand All @@ -85,7 +85,7 @@ def memory_size(self, human_readable=True):
return return_data
return None

def memory_available_swap(self, human_readable=True):
def memory_available_swap(self, human_readable=False):
"""Total available memory swap."""
if self.memory:
# Memory is actually returned in KB's so multiply before converting
Expand All @@ -95,7 +95,7 @@ def memory_available_swap(self, human_readable=True):
return return_data
return None

def memory_cached(self, human_readable=True):
def memory_cached(self, human_readable=False):
"""Total cached memory."""
if self.memory:
# Memory is actually returned in KB's so multiply before converting
Expand All @@ -105,7 +105,7 @@ def memory_cached(self, human_readable=True):
return return_data
return None

def memory_available_real(self, human_readable=True):
def memory_available_real(self, human_readable=False):
"""Real available memory."""
if self.memory:
# Memory is actually returned in KB's so multiply before converting
Expand All @@ -115,7 +115,7 @@ def memory_available_real(self, human_readable=True):
return return_data
return None

def memory_total_real(self, human_readable=True):
def memory_total_real(self, human_readable=False):
"""Total available real memory."""
if self.memory:
# Memory is actually returned in KB's so multiply before converting
Expand All @@ -125,7 +125,7 @@ def memory_total_real(self, human_readable=True):
return return_data
return None

def memory_total_swap(self, human_readable=True):
def memory_total_swap(self, human_readable=False):
"""Total swap memory."""
if self.memory:
# Memory is actually returned in KB's so multiply before converting
Expand All @@ -147,7 +147,7 @@ def _get_network(self, network_id):
return network
return None

def network_up(self, human_readable=True):
def network_up(self, human_readable=False):
"""Total upload speed being used."""
network = self._get_network("total")
if network:
Expand All @@ -157,7 +157,7 @@ def network_up(self, human_readable=True):
return return_data
return None

def network_down(self, human_readable=True):
def network_down(self, human_readable=False):
"""Total download speed being used."""
network = self._get_network("total")
if network:
Expand Down
4 changes: 2 additions & 2 deletions synology_dsm/api/storage/storage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ def volume_device_type(self, volume_id):
"""Returns the volume type (RAID1, RAID2, etc)."""
return self._get_volume(volume_id).get("device_type")

def volume_size_total(self, volume_id, human_readable=True):
def volume_size_total(self, volume_id, human_readable=False):
"""Total size of volume."""
volume = self._get_volume(volume_id)
if volume.get("size"):
Expand All @@ -76,7 +76,7 @@ def volume_size_total(self, volume_id, human_readable=True):
return return_data
return None

def volume_size_used(self, volume_id, human_readable=True):
def volume_size_used(self, volume_id, human_readable=False):
"""Total used size in volume."""
volume = self._get_volume(volume_id)
if volume.get("size"):
Expand Down
96 changes: 52 additions & 44 deletions tests/test_synology_dsm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,18 +219,26 @@ def test_utilisation_memory(self):
"""Test utilization memory."""
assert self.api.utilisation.memory
assert self.api.utilisation.memory_real_usage
assert self.api.utilisation.memory_size
assert self.api.utilisation.memory_available_swap
assert self.api.utilisation.memory_cached
assert self.api.utilisation.memory_available_real
assert self.api.utilisation.memory_total_real
assert self.api.utilisation.memory_total_swap
assert self.api.utilisation.memory_size()
assert self.api.utilisation.memory_size(True)
assert self.api.utilisation.memory_available_swap()
assert self.api.utilisation.memory_available_swap(True)
assert self.api.utilisation.memory_cached()
assert self.api.utilisation.memory_cached(True)
assert self.api.utilisation.memory_available_real()
assert self.api.utilisation.memory_available_real(True)
assert self.api.utilisation.memory_total_real()
assert self.api.utilisation.memory_total_real(True)
assert self.api.utilisation.memory_total_swap()
assert self.api.utilisation.memory_total_swap(True)

def test_utilisation_network(self):
"""Test utilization network."""
assert self.api.utilisation.network
assert self.api.utilisation.network_up
assert self.api.utilisation.network_down
assert self.api.utilisation.network_up()
assert self.api.utilisation.network_up(True)
assert self.api.utilisation.network_down()
assert self.api.utilisation.network_down(True)

def test_storage(self):
"""Test storage roots."""
Expand All @@ -250,20 +258,20 @@ def test_storage_raid_volumes(self):
assert self.api.storage.volume_status(volume_id)
assert self.api.storage.volume_device_type(volume_id)
assert self.api.storage.volume_size_total(volume_id)
assert self.api.storage.volume_size_total(volume_id, False)
assert self.api.storage.volume_size_total(volume_id, True)
assert self.api.storage.volume_size_used(volume_id)
assert self.api.storage.volume_size_used(volume_id, False)
assert self.api.storage.volume_size_used(volume_id, True)
assert self.api.storage.volume_percentage_used(volume_id)
assert self.api.storage.volume_disk_temp_avg(volume_id)
assert self.api.storage.volume_disk_temp_max(volume_id)

# Existing volume
assert self.api.storage.volume_status("volume_1") == "normal"
assert self.api.storage.volume_device_type("volume_1") == "raid_5"
assert self.api.storage.volume_size_total("volume_1") == "7.0Tb"
assert self.api.storage.volume_size_total("volume_1", False) == 7672030584832
assert self.api.storage.volume_size_used("volume_1") == "4.0Tb"
assert self.api.storage.volume_size_used("volume_1", False) == 4377452806144
assert self.api.storage.volume_size_total("volume_1") == 7672030584832
assert self.api.storage.volume_size_total("volume_1", True) == "7.0Tb"
assert self.api.storage.volume_size_used("volume_1") == 4377452806144
assert self.api.storage.volume_size_used("volume_1", True) == "4.0Tb"
assert self.api.storage.volume_percentage_used("volume_1") == 57.1
assert self.api.storage.volume_disk_temp_avg("volume_1") == 24.0
assert self.api.storage.volume_disk_temp_max("volume_1") == 24
Expand All @@ -272,9 +280,9 @@ def test_storage_raid_volumes(self):
assert not self.api.storage.volume_status("not_a_volume")
assert not self.api.storage.volume_device_type("not_a_volume")
assert not self.api.storage.volume_size_total("not_a_volume")
assert not self.api.storage.volume_size_total("not_a_volume", False)
assert not self.api.storage.volume_size_total("not_a_volume", True)
assert not self.api.storage.volume_size_used("not_a_volume")
assert not self.api.storage.volume_size_used("not_a_volume", False)
assert not self.api.storage.volume_size_used("not_a_volume", True)
assert not self.api.storage.volume_percentage_used("not_a_volume")
assert not self.api.storage.volume_disk_temp_avg("not_a_volume")
assert not self.api.storage.volume_disk_temp_max("not_a_volume")
Expand All @@ -283,9 +291,9 @@ def test_storage_raid_volumes(self):
assert self.api.storage.volume_status("test_volume") is None
assert self.api.storage.volume_device_type("test_volume") is None
assert self.api.storage.volume_size_total("test_volume") is None
assert self.api.storage.volume_size_total("test_volume", False) is None
assert self.api.storage.volume_size_total("test_volume", True) is None
assert self.api.storage.volume_size_used("test_volume") is None
assert self.api.storage.volume_size_used("test_volume", False) is None
assert self.api.storage.volume_size_used("test_volume", True) is None
assert self.api.storage.volume_percentage_used("test_volume") is None
assert self.api.storage.volume_disk_temp_avg("test_volume") is None
assert self.api.storage.volume_disk_temp_max("test_volume") is None
Expand All @@ -305,30 +313,30 @@ def test_storage_shr_volumes(self):
assert api.storage.volume_status(volume_id)
assert api.storage.volume_device_type(volume_id)
assert api.storage.volume_size_total(volume_id)
assert api.storage.volume_size_total(volume_id, False)
assert api.storage.volume_size_total(volume_id, True)
assert api.storage.volume_size_used(volume_id)
assert api.storage.volume_size_used(volume_id, False)
assert api.storage.volume_size_used(volume_id, True)
assert api.storage.volume_percentage_used(volume_id)
assert api.storage.volume_disk_temp_avg(volume_id)
assert api.storage.volume_disk_temp_max(volume_id)

# Existing volume
assert api.storage.volume_status("volume_1") == "normal"
assert api.storage.volume_device_type("volume_1") == "shr_without_disk_protect"
assert api.storage.volume_size_total("volume_1") == "2.7Tb"
assert api.storage.volume_size_total("volume_1", False) == 2948623499264
assert api.storage.volume_size_used("volume_1") == "2.5Tb"
assert api.storage.volume_size_used("volume_1", False) == 2710796488704
assert api.storage.volume_size_total("volume_1") == 2948623499264
assert api.storage.volume_size_total("volume_1", True) == "2.7Tb"
assert api.storage.volume_size_used("volume_1") == 2710796488704
assert api.storage.volume_size_used("volume_1", True) == "2.5Tb"
assert api.storage.volume_percentage_used("volume_1") == 91.9
assert api.storage.volume_disk_temp_avg("volume_1") == 29.0
assert api.storage.volume_disk_temp_max("volume_1") == 29

assert api.storage.volume_status("volume_2") == "normal"
assert api.storage.volume_device_type("volume_2") == "shr_without_disk_protect"
assert api.storage.volume_size_total("volume_2") == "1.8Tb"
assert api.storage.volume_size_total("volume_2", False) == 1964124495872
assert api.storage.volume_size_used("volume_2") == "1.5Tb"
assert api.storage.volume_size_used("volume_2", False) == 1684179374080
assert api.storage.volume_size_total("volume_2") == 1964124495872
assert api.storage.volume_size_total("volume_2", True) == "1.8Tb"
assert api.storage.volume_size_used("volume_2") == 1684179374080
assert api.storage.volume_size_used("volume_2", True) == "1.5Tb"
assert api.storage.volume_percentage_used("volume_2") == 85.7
assert api.storage.volume_disk_temp_avg("volume_2") == 30.0
assert api.storage.volume_disk_temp_max("volume_2") == 30
Expand All @@ -337,9 +345,9 @@ def test_storage_shr_volumes(self):
assert not api.storage.volume_status("not_a_volume")
assert not api.storage.volume_device_type("not_a_volume")
assert not api.storage.volume_size_total("not_a_volume")
assert not api.storage.volume_size_total("not_a_volume", False)
assert not api.storage.volume_size_total("not_a_volume", True)
assert not api.storage.volume_size_used("not_a_volume")
assert not api.storage.volume_size_used("not_a_volume", False)
assert not api.storage.volume_size_used("not_a_volume", True)
assert not api.storage.volume_percentage_used("not_a_volume")
assert not api.storage.volume_disk_temp_avg("not_a_volume")
assert not api.storage.volume_disk_temp_max("not_a_volume")
Expand All @@ -348,9 +356,9 @@ def test_storage_shr_volumes(self):
assert api.storage.volume_status("test_volume") is None
assert api.storage.volume_device_type("test_volume") is None
assert api.storage.volume_size_total("test_volume") is None
assert api.storage.volume_size_total("test_volume", False) is None
assert api.storage.volume_size_total("test_volume", True) is None
assert api.storage.volume_size_used("test_volume") is None
assert api.storage.volume_size_used("test_volume", False) is None
assert api.storage.volume_size_used("test_volume", True) is None
assert api.storage.volume_percentage_used("test_volume") is None
assert api.storage.volume_disk_temp_avg("test_volume") is None
assert api.storage.volume_disk_temp_max("test_volume") is None
Expand All @@ -368,20 +376,20 @@ def test_storage_shr2_volumes(self):
assert api.storage.volume_status(volume_id)
assert api.storage.volume_device_type(volume_id)
assert api.storage.volume_size_total(volume_id)
assert api.storage.volume_size_total(volume_id, False)
assert api.storage.volume_size_total(volume_id, True)
assert api.storage.volume_size_used(volume_id)
assert api.storage.volume_size_used(volume_id, False)
assert api.storage.volume_size_used(volume_id, True)
assert api.storage.volume_percentage_used(volume_id)
assert api.storage.volume_disk_temp_avg(volume_id)
assert api.storage.volume_disk_temp_max(volume_id)

# Existing volume
assert api.storage.volume_status("volume_1") == "normal"
assert api.storage.volume_device_type("volume_1") == "shr_with_2_disk_protect"
assert api.storage.volume_size_total("volume_1") == "34.9Tb"
assert api.storage.volume_size_total("volume_1", False) == 38378964738048
assert api.storage.volume_size_used("volume_1") == "24.3Tb"
assert api.storage.volume_size_used("volume_1", False) == 26724878606336
assert api.storage.volume_size_total("volume_1") == 38378964738048
assert api.storage.volume_size_total("volume_1", True) == "34.9Tb"
assert api.storage.volume_size_used("volume_1") == 26724878606336
assert api.storage.volume_size_used("volume_1", True) == "24.3Tb"
assert api.storage.volume_percentage_used("volume_1") == 69.6
assert api.storage.volume_disk_temp_avg("volume_1") == 37.0
assert api.storage.volume_disk_temp_max("volume_1") == 41
Expand All @@ -399,20 +407,20 @@ def test_storage_shr2_expansion_volumes(self):
assert api.storage.volume_status(volume_id)
assert api.storage.volume_device_type(volume_id)
assert api.storage.volume_size_total(volume_id)
assert api.storage.volume_size_total(volume_id, False)
assert api.storage.volume_size_total(volume_id, True)
assert api.storage.volume_size_used(volume_id)
assert api.storage.volume_size_used(volume_id, False)
assert api.storage.volume_size_used(volume_id, True)
assert api.storage.volume_percentage_used(volume_id)
assert api.storage.volume_disk_temp_avg(volume_id)
assert api.storage.volume_disk_temp_max(volume_id)

# Existing volume
assert api.storage.volume_status("volume_1") == "normal"
assert api.storage.volume_device_type("volume_1") == "shr_with_2_disk_protect"
assert api.storage.volume_size_total("volume_1") == "28.8Tb"
assert api.storage.volume_size_total("volume_1", False) == 31714659872768
assert api.storage.volume_size_used("volume_1") == "23.1Tb"
assert api.storage.volume_size_used("volume_1", False) == 25419707531264
assert api.storage.volume_size_total("volume_1") == 31714659872768
assert api.storage.volume_size_total("volume_1", True) == "28.8Tb"
assert api.storage.volume_size_used("volume_1") == 25419707531264
assert api.storage.volume_size_used("volume_1", True) == "23.1Tb"
assert api.storage.volume_percentage_used("volume_1") == 80.2
assert api.storage.volume_disk_temp_avg("volume_1") == 33.0
assert api.storage.volume_disk_temp_max("volume_1") == 35
Expand Down
Loading