Merge pull request #90 from DMTF/Fix88-SSDP-IPv6

SSDP updates

Author: mraineri

redfish_protocol_validator/service_details.py

@@ -106,13 +106,15 @@ def test_event_error_on_bad_request(sut: SystemUnderTest):
 
 def pre_ssdp(sut: SystemUnderTest):
     """Perform prerequisite SSDP steps"""
-    # discover using the redfish search target
-    services = utils.discover_ssdp(search_target=SSDP_REDFISH)
-    sut.add_ssdp_services(SSDP_REDFISH, services)
+    # try to discover with both IPv4 and IPv6
+    for protocol in ['ipv4', 'ipv6']:
+        # discover using the redfish search target
+        services = utils.discover_ssdp(search_target=SSDP_REDFISH, protocol=protocol)
+        sut.add_ssdp_services(SSDP_REDFISH, services)
 
-    # discover using the ssdp:all search target
-    services = utils.discover_ssdp(search_target=SSDP_ALL)
-    sut.add_ssdp_services(SSDP_ALL, services)
+        # discover using the ssdp:all search target
+        services = utils.discover_ssdp(search_target=SSDP_ALL, protocol=protocol)
+        sut.add_ssdp_services(SSDP_ALL, services)
 
     # determine SSDP enabled/disabled state
     if sut.mgr_net_proto_uri:
@@ -317,20 +319,26 @@ def test_ssdp_st_header_format(sut: SystemUnderTest):
                 Assertion.SERV_SSDP_ST_HEADER_FORMAT, msg)
         return
 
-    st_minor = 0
-    msg_minor = 'missing'
     if m.group(1):
         st_minor = int(m.group(1).lstrip(':'))
         msg_minor = str(st_minor)
-    # if the service minor ver is non-zero, must be included in the ST header
-    if sut.version_tuple.minor != 0 and sut.version_tuple.minor != st_minor:
-        # FAIL minor version incorrectly specified in ST header
-        msg = ('The Redfish protocol minor version from the Service Root is '
-               '%s, but the minor version in the ST header is %s'
-               % (sut.version_tuple.minor, msg_minor))
-        sut.log(Result.FAIL, '', '', st_header,
-                Assertion.SERV_SSDP_ST_HEADER_FORMAT, msg)
-        return
+        # only test the minor version if provided in the header
+        # returning the minor version is not required
+        if sut.version_tuple.minor != st_minor:
+            # FAIL minor version incorrectly specified in ST header
+            msg = ('The Redfish protocol minor version from the service root is '
+                   '%s, but the minor version in the ST header is %s'
+                   % (sut.version_tuple.minor, msg_minor))
+            sut.log(Result.FAIL, '', '', st_header,
+                    Assertion.SERV_SSDP_ST_HEADER_FORMAT, msg)
+            return
+        if sut.version_tuple.minor == 0:
+            # FAIL minor version is not allowed if its 0
+            msg = ('The Redfish protocol minor version from the service root is '
+                   '0, but the ST header contained a minor version')
+            sut.log(Result.FAIL, '', '', st_header,
+                    Assertion.SERV_SSDP_ST_HEADER_FORMAT, msg)
+            return
 
     # PASS if we have not already logged a result and returned
     sut.log(Result.PASS, '', '', st_header,

redfish_protocol_validator/system_under_test.py

@@ -190,7 +190,9 @@ def mgr_net_proto_uri(self):
         return self._mgr_net_proto_uri
 
     def add_ssdp_services(self, search_target, services):
-        self._ssdp_services[search_target] = services
+        if search_target not in self._ssdp_services:
+            self._ssdp_services[search_target] = {}
+        self._ssdp_services[search_target].update(services)
 
     def get_ssdp_services(self, search_target):
         return self._ssdp_services.get(search_target, {})

redfish_protocol_validator/utils.py

@@ -363,13 +363,18 @@ def discover_ssdp(port=1900, ttl=2, response_time=3, iface=None,
     socket.setdefaulttimeout(response_time + 2)
 
     # Set up the socket and send the request
-    sock = socket.socket(af_type, socket.SOCK_DGRAM, socket.IPPROTO_UDP)
-    sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-    sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, ttl)
-    if iface:
-        sock.setsockopt(socket.SOL_SOCKET, socket.SO_BINDTODEVICE,
-                        str(iface+'\0').encode('utf-8'))
-    sock.sendto(bytearray(msearch_str, 'utf-8'), mcast_connection)
+    try:
+        sock = socket.socket(af_type, socket.SOCK_DGRAM, socket.IPPROTO_UDP)
+        sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+        sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, ttl)
+        if iface:
+            sock.setsockopt(socket.SOL_SOCKET, socket.SO_BINDTODEVICE,
+                            str(iface+'\0').encode('utf-8'))
+        sock.sendto(bytearray(msearch_str, 'utf-8'), mcast_connection)
+    except:
+        # Covers cases where the system may not support IPv6
+        sock.close()
+        return {}
 
     # On the same socket, wait for responses
     discovered_services = {}

unittests/test_service_details.py

@@ -505,8 +505,8 @@ def test_test_ssdp_st_header_format_fail2(self):
 
     def test_test_ssdp_st_header_format_fail3(self):
         self.sut.set_service_uuid(self.uuid)
-        self.sut.set_version('1.6.0')
-        st = 'urn:dmtf-org:service:redfish-rest:1'  # missing minor version
+        self.sut.set_version('1.0.0')
+        st = 'urn:dmtf-org:service:redfish-rest:1:0'  # minor version is 0
         services = {
             self.uuid: {
                 'USN': 'abc',
@@ -520,7 +520,7 @@ def test_test_ssdp_st_header_format_fail3(self):
             '', st)
         self.assertIsNotNone(result)
         self.assertEqual(Result.FAIL, result['result'])
-        self.assertIn('6, but the minor version in the ST header is missing',
+        self.assertIn('0, but the ST header contained a minor version',
                       result['msg'])
 
     def test_test_ssdp_st_header_format_fail4(self):