Skip to content

Commit

Permalink
[TC_DGSW] Symplify Validation Assertions
Browse files Browse the repository at this point in the history
  • Loading branch information
@yufengwangca
yufengwangca committed Jan 8, 2025
1 parent f25f635 commit 56e17e6
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 33 deletions.
31 changes: 20 additions & 11 deletions src/python_testing/TC_DGSW_2_1.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,18 @@ def is_valid_uint32_value(value):
def is_valid_str_value(value):
return isinstance(value, str) and len(value) > 0

def assert_valid_uint64(self, value, field_name):
"""Asserts that the value is a valid uint64."""
asserts.assert_true(self.is_valid_uint64_value(value), f"{field_name} field should be a uint64 type")

def assert_valid_uint32(self, value, field_name):
"""Asserts that the value is a valid uint32."""
asserts.assert_true(self.is_valid_uint32_value(value), f"{field_name} field should be a uint32 type")

def assert_valid_str(self, value, field_name):
"""Asserts that the value is a non-empty string."""
asserts.assert_true(self.is_valid_str_value(value), f"{field_name} field should be a non-empty string")

async def read_dgsw_attribute_expect_success(self, endpoint, attribute):
cluster = Clusters.Objects.SoftwareDiagnostics
return await self.read_single_attribute_check_success(endpoint=endpoint, cluster=cluster, attribute=attribute)
Expand Down Expand Up @@ -94,44 +106,41 @@ async def test_TC_DGSW_2_1(self):
# Validate each element in the thread_metrics_list
for metric in thread_metrics_list:
# The Id field is mandatory
asserts.assert_true(self.is_valid_uint64_value(metric.id), "Id field should be a uint64 type")
self.assert_valid_uint64(metric.id, "Id")

# Validate the optional Name field
if metric.name is not None:
asserts.assert_true(self.is_valid_str_value(metric.name), "Name field should be a string type")
self.assert_valid_str(metric.name, "Name")

# Validate the optional StackFreeCurrent field
if metric.stackFreeCurrent is not None:
asserts.assert_true(self.is_valid_uint32_value(metric.stackFreeCurrent),
"StackFreeCurrent field should be a uint32 type")
self.assert_valid_uint32(metric.stackFreeCurrent, "StackFreeCurrent")

# Validate the optional StackFreeMinimum field
if metric.stackFreeMinimum is not None:
asserts.assert_true(self.is_valid_uint32_value(metric.stackFreeMinimum),
"StackFreeMinimum field should be a uint32 type")
self.assert_valid_uint32(metric.stackFreeMinimum, "StackFreeMinimum")

# Validate the optional StackSize field
if metric.stackSize is not None:
asserts.assert_true(self.is_valid_uint32_value(metric.stackSize), "StackSize field should be a uint32 type")
self.assert_valid_uint32(metric.stackSize, "StackSize")

# STEP 3: TH reads from the DUT the CurrentHeapFree attribute
self.step(3)
if self.pics_guard(attributes.CurrentHeapFree.attribute_id in attribute_list):
current_heap_free_attr = await self.read_dgsw_attribute_expect_success(endpoint=endpoint, attribute=attributes.CurrentHeapFree)
asserts.assert_true(self.is_valid_uint64_value(current_heap_free_attr), "CurrentHeapFree field should be a uint64 type")
self.assert_valid_uint64(current_heap_free_attr, "CurrentHeapFree")

# STEP 4: TH reads from the DUT the CurrentHeapUsed attribute
self.step(4)
if self.pics_guard(attributes.CurrentHeapUsed.attribute_id in attribute_list):
current_heap_used_attr = await self.read_dgsw_attribute_expect_success(endpoint=endpoint, attribute=attributes.CurrentHeapUsed)
asserts.assert_true(self.is_valid_uint64_value(current_heap_used_attr), "CurrentHeapUsed field should be a uint64 type")
self.assert_valid_uint64(current_heap_used_attr, "CurrentHeapUsed")

# STEP 5: TH reads from the DUT the CurrentHeapHighWatermark attribute
self.step(5)
if self.pics_guard(attributes.CurrentHeapHighWatermark.attribute_id in attribute_list):
current_heap_high_watermark_attr = await self.read_dgsw_attribute_expect_success(endpoint=endpoint, attribute=attributes.CurrentHeapHighWatermark)
asserts.assert_true(self.is_valid_uint64_value(current_heap_high_watermark_attr),
"CurrentHeapHighWatermark field should be a uint64 type")
self.assert_valid_uint64(current_heap_high_watermark_attr, "CurrentHeapHighWatermark")


if __name__ == "__main__":
Expand Down
49 changes: 27 additions & 22 deletions src/python_testing/TC_DGSW_2_3.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,18 @@ def is_valid_uint32_value(value):
def is_valid_str_value(value):
return isinstance(value, str) and len(value) > 0

def assert_valid_uint64(self, value, field_name):
"""Asserts that the value is a valid uint64."""
asserts.assert_true(self.is_valid_uint64_value(value), f"{field_name} field should be a uint64 type")

def assert_valid_uint32(self, value, field_name):
"""Asserts that the value is a valid uint32."""
asserts.assert_true(self.is_valid_uint32_value(value), f"{field_name} field should be a uint32 type")

def assert_valid_str(self, value, field_name):
"""Asserts that the value is a non-empty string."""
asserts.assert_true(self.is_valid_str_value(value), f"{field_name} field should be a non-empty string")

async def read_dgsw_attribute_expect_success(self, endpoint, attribute):
cluster = Clusters.Objects.SoftwareDiagnostics
return await self.read_single_attribute_check_success(endpoint=endpoint, cluster=cluster, attribute=attribute)
Expand All @@ -67,7 +79,7 @@ async def send_reset_watermarks_command(self):

def desc_TC_DGSW_2_3(self) -> str:
"""Returns a description of this test"""
return "[TC-DGSW-2.1] Attributes with Server as DUT"
return "[TC-DGSW-2.3] Attributes with Server as DUT"

def pics_TC_DGSW_2_3(self) -> list[str]:
return ["DGSW.S"]
Expand Down Expand Up @@ -106,35 +118,32 @@ async def test_TC_DGSW_2_3(self):
# Iterate over all items in the list and validate each one
for metric in thread_metrics_original:
# The Id field is mandatory
asserts.assert_true(self.is_valid_uint64_value(metric.id), "Id field should be a uint64 type")
self.assert_valid_uint64(metric.id, "Id")

if metric.name is not None:
asserts.assert_true(self.is_valid_str_value(metric.name), "Name field should be a string type")
self.assert_valid_str(metric.name, "Name")

if metric.stackFreeCurrent is not None:
asserts.assert_true(self.is_valid_uint32_value(metric.stackFreeCurrent),
"StackFreeCurrent field should be a uint32 type")
self.assert_valid_uint32(metric.stackFreeCurrent, "StackFreeCurrent")

if metric.stackFreeMinimum is not None:
asserts.assert_true(self.is_valid_uint32_value(metric.stackFreeMinimum),
"StackFreeMinimum field should be a uint32 type")
self.assert_valid_uint32(metric.stackFreeMinimum, "StackFreeMinimum")

if metric.stackSize is not None:
asserts.assert_true(self.is_valid_uint32_value(metric.stackSize), "StackSize field should be a uint32 type")
self.assert_valid_uint32(metric.stackSize, "StackSize")

# STEP 4: TH reads from the DUT the CurrentHeapHighWatermark attribute
self.step(4)
if self.pics_guard(attributes.CurrentHeapHighWatermark.attribute_id in attribute_list):
high_watermark_original = await self.read_dgsw_attribute_expect_success(endpoint=endpoint, attribute=attributes.CurrentHeapHighWatermark)
asserts.assert_true(self.is_valid_uint64_value(high_watermark_original),
"CurrentHeapHighWatermark field should be a uint64 type")
self.assert_valid_uint64(high_watermark_original, "CurrentHeapHighWatermark")

# STEP 5: TH reads from the DUT the CurrentHeapUsed attribute
self.step(5)
if self.pics_guard(attributes.CurrentHeapUsed.attribute_id in attribute_list):
current_heap_used_original = await self.read_dgsw_attribute_expect_success(endpoint=endpoint, attribute=attributes.CurrentHeapUsed)
asserts.assert_true(self.is_valid_uint64_value(current_heap_used_original),
"CurrentHeapUsed field should be a uint64 type")
self.assert_valid_uint64(current_heap_used_original, "CurrentHeapUsed")

if high_watermark_original is not None:
asserts.assert_true(current_heap_used_original <= high_watermark_original,
"CurrentHeapUsed should be less than or equal to CurrentHeapHighWatermark")
Expand All @@ -148,8 +157,7 @@ async def test_TC_DGSW_2_3(self):
self.step(7)
if self.pics_guard(attributes.CurrentHeapHighWatermark.attribute_id in attribute_list):
current_heap_high_watermark = await self.read_dgsw_attribute_expect_success(endpoint=endpoint, attribute=attributes.CurrentHeapHighWatermark)
asserts.assert_true(self.is_valid_uint64_value(current_heap_high_watermark),
"CurrentHeapHighWatermark field should be a uint64 type")
self.assert_valid_uint64(current_heap_high_watermark, "CurrentHeapHighWatermark")

# Verify that the returned value is <= high_watermark_original
asserts.assert_true(current_heap_high_watermark <= high_watermark_original,
Expand All @@ -168,22 +176,19 @@ async def test_TC_DGSW_2_3(self):

# Validate all elements in the list
for metric in thread_metrics_reset:
# The Id field is mandatory
asserts.assert_true(self.is_valid_uint64_value(metric.id), "Id field should be a uint64 type")
self.assert_valid_uint64(metric.id, "Id")

if metric.name is not None:
asserts.assert_true(self.is_valid_str_value(metric.name), "Name field should be a string type")
self.assert_valid_str(metric.name, "Name")

if metric.stackFreeCurrent is not None:
asserts.assert_true(self.is_valid_uint32_value(metric.stackFreeCurrent),
"StackFreeCurrent field should be a uint32 type")
self.assert_valid_uint32(metric.stackFreeCurrent, "StackFreeCurrent")

if metric.stackFreeMinimum is not None:
asserts.assert_true(self.is_valid_uint32_value(metric.stackFreeMinimum),
"StackFreeMinimum field should be a uint32 type")
self.assert_valid_uint32(metric.stackFreeMinimum, "StackFreeMinimum")

if metric.stackSize is not None:
asserts.assert_true(self.is_valid_uint32_value(metric.stackSize), "StackSize field should be a uint32 type")
self.assert_valid_uint32(metric.stackSize, "StackSize")

# Ensure the list length matches thread_metrics_original to simplify matching
asserts.assert_equal(len(thread_metrics_reset), len(thread_metrics_original),
Expand Down

0 comments on commit 56e17e6

Please sign in to comment.