Skip to content

Commit

Permalink
Addresses latest
Browse files Browse the repository at this point in the history
  • Loading branch information
@raul-marquez-csa
raul-marquez-csa committed Oct 15, 2024
1 parent 819ea06 commit 5b05c69
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 29 deletions.
16 changes: 9 additions & 7 deletions src/python_testing/TC_SC_4_3.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,11 +177,13 @@ def extract_ipv6_address(text):

@staticmethod
def verify_hostname(hostname: str) -> bool:
# Remove '.local' or '.local.' suffix if present
# Remove any trailing dot
if hostname.endswith('.'):
hostname = hostname[:-1]

# Remove '.local' suffix if present
if hostname.endswith('.local'):
hostname = hostname[:-6]
elif hostname.endswith('.local.'):
hostname = hostname[:-7]

# Regular expression to match an uppercase hexadecimal string of 12 or 16 characters
pattern = re.compile(r'^[0-9A-F]{12}$|^[0-9A-F]{16}$')
Expand All @@ -204,17 +206,17 @@ async def test_TC_SC_4_3(self):
self.step(2)
ep0_servers = await self.get_descriptor_server_list()

# Check if ep0_servers contains the ICD Management cluster ID (0x0046)
# Check if ep0_servers contain the ICD Management cluster ID (0x0046)
supports_icd = Clusters.IcdManagement.id in ep0_servers
logging.info(f"\n\n\tsupports_icd: {supports_icd}\n\n")
logging.info(f"supports_icd: {supports_icd}")

# *** STEP 3 ***
# If supports_icd is true, TH reads ActiveModeThreshold from the ICD Management cluster on EP0 and saves
# as active_mode_threshold.
self.step(3)
if supports_icd:
active_mode_threshold_ms = await self.get_idle_mode_threshhold_ms()
logging.info(f"\n\n\tactive_mode_threshold_ms: {active_mode_threshold_ms}\n\n")
logging.info(f"active_mode_threshold_ms: {active_mode_threshold_ms}")

# *** STEP 4 ***
# If supports_icd is true, TH reads FeatureMap from the ICD Management cluster on EP0. If the LITS feature
Expand All @@ -224,7 +226,7 @@ async def test_TC_SC_4_3(self):
feature_map = await self.get_icd_feature_map()
LITS = Clusters.IcdManagement.Bitmaps.Feature.kLongIdleTimeSupport
supports_lit = bool(feature_map & LITS == LITS)
logging.info(f"\n\n\tkLongIdleTimeSupport set: {supports_lit}\n\n")
logging.info(f"kLongIdleTimeSupport set: {supports_lit}")

# *** STEP 5 ***
# TH constructs the instance name for the DUT as the 64-bit compressed Fabric identifier, and the
Expand Down
54 changes: 32 additions & 22 deletions src/python_testing/mdns_discovery/mdns_discovery.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,14 +84,14 @@ class MdnsServiceType(Enum):

class MdnsServiceListener(ServiceListener):
"""
A service listener required for the TXT record data to get populated and come back
A service listener required during mDNS service discovery
"""

def __init__(self):
self.updated_event = asyncio.Event()

def add_service(self, zeroconf: Zeroconf, service_type: str, name: str) -> None:
sleep(0.25)
sleep(0.125)
self.updated_event.set()

def remove_service(self, zeroconf: Zeroconf, service_type: str, name: str) -> None:
Expand Down Expand Up @@ -141,7 +141,7 @@ async def get_commissioner_service(self, log_output: bool = False,
"""
Asynchronously discovers a commissioner mDNS service within the network.
Args:
Optional args:
log_output (bool): Logs the discovered services to the console. Defaults to False.
discovery_timeout_sec (float): Defaults to 15 seconds.
Expand All @@ -157,7 +157,7 @@ async def get_commissionable_service(self, log_output: bool = False,
"""
Asynchronously discovers a commissionable mDNS service within the network.
Args:
Optional args:
log_output (bool): Logs the discovered services to the console. Defaults to False.
discovery_timeout_sec (float): Defaults to 15 seconds.
Expand All @@ -176,16 +176,19 @@ async def get_operational_service(self,
"""
Asynchronously discovers an operational mDNS service within the network.
Args:
Optional args:
log_output (bool): Logs the discovered services to the console. Defaults to False.
discovery_timeout_sec (float): Defaults to 15 seconds.
node_id: the node id to create the service name from
compressed_fabric_id: the fabric id to create the service name from
node_id: the node id to create the service name from
compressed_fabric_id: the fabric id to create the service name from
Returns:
Optional[MdnsServiceInfo]: An instance of MdnsServiceInfo or None if timeout reached.
"""
# Validation to ensure both or none of the parameters are provided

# Validation to ensure that both node_id and compressed_fabric_id are provided or both are None.
if (node_id is None) != (compressed_fabric_id is None):
raise ValueError("Both node_id and compressed_fabric_id must be provided together or not at all.")

self._name_filter = f'{compressed_fabric_id:016x}-{node_id:016x}.{MdnsServiceType.OPERATIONAL.value}'.upper()
return await self._get_service(MdnsServiceType.OPERATIONAL, log_output, discovery_timeout_sec)
Expand All @@ -196,7 +199,7 @@ async def get_border_router_service(self, log_output: bool = False,
"""
Asynchronously discovers a border router mDNS service within the network.
Args:
Optional args:
log_output (bool): Logs the discovered services to the console. Defaults to False.
discovery_timeout_sec (float): Defaults to 15 seconds.
Expand All @@ -211,7 +214,7 @@ async def get_all_services(self, log_output: bool = False,
"""
Asynchronously discovers all available mDNS services within the network.
Args:
Optional args:
log_output (bool): Logs the discovered services to the console. Defaults to False.
discovery_timeout_sec (float): Defaults to 15 seconds.
Expand All @@ -229,7 +232,7 @@ async def get_service_types(self, log_output: bool = False, discovery_timeout_se
of the service types discovered. This method utilizes the AsyncZeroconfServiceTypes.async_find()
function to perform the network scan for mDNS services.
Args:
Optional args:
log_output (bool): If set to True, the discovered service types are logged to the console.
This can be useful for debugging or informational purposes. Defaults to False.
discovery_timeout_sec (float): The maximum time (in seconds) to wait for the discovery process. Defaults to 10.0 seconds.
Expand All @@ -242,11 +245,11 @@ async def get_service_types(self, log_output: bool = False, discovery_timeout_se
try:
discovered_services = list(await asyncio.wait_for(AsyncZeroconfServiceTypes.async_find(), timeout=discovery_timeout_sec))
except asyncio.TimeoutError:
print(f"MDNS service types discovery timed out after {discovery_timeout_sec} seconds.")
logger.info(f"MDNS service types discovery timed out after {discovery_timeout_sec} seconds.")
discovered_services = []

if log_output:
print(f"MDNS discovered service types: {discovered_services}")
logger.info(f"MDNS discovered service types: {discovered_services}")

return discovered_services

Expand All @@ -260,12 +263,19 @@ async def get_service_by_record_type(self, service_name: str,
Asynchronously discovers an mDNS service within the network by service name, service type,
and record type.
Args:
Required args:
service_name (str): The unique name of the mDNS service.
Example:
C82B83803DECA0B2-0000000012344321._matter._tcp.local.
record_type (DNSRecordType): The type of record to look for (SRV, TXT, AAAA, A).
Example:
_matterd._tcp.local. (from the MdnsServiceType enum)
Optional args:
service_type (str): The service type of the service. Defaults to None.
log_output (bool): Logs the discovered services to the console. Defaults to False.
discovery_timeout_sec (float): Defaults to 15 seconds.
service_name (str): The unique name of the mDNS service. Defaults to None.
service_type (str): The service type of the service. Defaults to None.
record_type (DNSRecordType): The type of record to look for (SRV, TXT, AAAA, A).
Returns:
Union[Optional[MdnsServiceInfo], Optional[DNSRecord]]: An instance of MdnsServiceInfo,
Expand All @@ -274,10 +284,10 @@ async def get_service_by_record_type(self, service_name: str,
mdns_service_info = None

if service_type:
print(
logger.info(
f"\nLooking for MDNS service type '{service_type}', service name '{service_name}', record type '{record_type.name}'\n")
else:
print(
logger.info(
f"\nLooking for MDNS service with service name '{service_name}', record type '{record_type.name}'\n")

# Adds service listener
Expand All @@ -288,7 +298,7 @@ async def get_service_by_record_type(self, service_name: str,
try:
await asyncio.wait_for(service_listener.updated_event.wait(), discovery_timeout_sec)
except asyncio.TimeoutError:
print(f"Service lookup for {service_name} timeout ({discovery_timeout_sec}) reached without an update.")
logger.info(f"Service lookup for {service_name} timeout ({discovery_timeout_sec}) reached without an update.")
finally:
self._zc.remove_service_listener(service_listener)

Expand All @@ -307,7 +317,7 @@ async def get_service_by_record_type(self, service_name: str,
dns_incoming = DNSIncoming(listener.data)
if dns_incoming.data:
answers = dns_incoming.answers()
print(f"\nIncoming DNSRecord: {answers}\n")
logger.info(f"\nIncoming DNSRecord: {answers}\n")
return answers.pop(0) if answers else None
else:
# Adds service to discovered services
Expand Down Expand Up @@ -510,7 +520,7 @@ async def _get_service(self, service_type: MdnsServiceType,

def _log_output(self) -> str:
"""
Converts the discovered services to a JSON string and log it.
Converts the discovered services to a JSON string and logs it.
The method is intended to be used for debugging or informational purposes, providing a clear and
comprehensive view of all services discovered during the mDNS service discovery process.
Expand Down

0 comments on commit 5b05c69

Please sign in to comment.