Merge pull request #2032 from peternewman/rdm-test-cherry-pick

E1.33 RDM Tests and other improvements

Author: peternewman

python/ola/RDMConstants.py

@@ -20,6 +20,8 @@
 __author__ = 'nomis52@gmail.com (Simon Newton)'
 
 
+RDM_MAX_PARAM_DATA_LENGTH = 231
+
 RDM_ZERO_FOOTPRINT_DMX_ADDRESS = 0xFFFF
 
 RDM_MANUFACTURER_PID_MIN = 0x8000
@@ -43,6 +45,8 @@
 
 RDM_MAX_TEST_DATA_PATTERN_LENGTH = 4096
 
+RDM_MAX_SEARCH_DOMAIN_LENGTH = 231
+
 
 def _ReverseDict(input):
   output = {}

tools/rdm/ModelCollector.py

@@ -220,7 +220,11 @@ def _HandleDeviceInfo(self, data):
                 'sensor_count',
                 'sub_device_count']
       for field in fields:
-        this_device[field] = data[field]
+        if field in data:
+          this_device[field] = data[field]
+        else:
+          print('Failed to get %s from device info for UID %s'
+                % (field, self.uid))
 
       this_device['software_versions'][data['software_version']] = {
           'languages': [],

tools/rdm/TestCategory.py

@@ -34,6 +34,7 @@ class TestCategory(object):
     'DISPLAY_SETTINGS': 'Display Settings',
     'CONFIGURATION': 'Configuration',
     'CONTROL': 'Control',
+    'E133_MANAGEMENT': 'E1.33 (RDMnet) Management',
     # And others for things that don't quite fit
     'CORE': 'Core Functionality',
     'ERROR_CONDITIONS': 'Error Conditions',

tools/rdm/TestDefinitions.py

@@ -28,6 +28,7 @@
                               RDM_MANUFACTURER_SD_MAX, RDM_MANUFACTURER_SD_MIN,
                               RDM_MAX_DOMAIN_NAME_LENGTH,
                               RDM_MAX_HOSTNAME_LENGTH,
+                              RDM_MAX_SEARCH_DOMAIN_LENGTH,
                               RDM_MAX_SERIAL_NUMBER_LENGTH,
                               RDM_MAX_STRING_LENGTH,
                               RDM_MAX_TEST_DATA_PATTERN_LENGTH,
@@ -8458,11 +8459,14 @@ class AllSubDevicesGetSearchDomain(TestMixins.AllSubDevicesGetMixin,
   PID = 'SEARCH_DOMAIN'
 
 
-# class GetSearchDomain(TestMixins.,
-#                       OptionalParameterTestFixture):
-#   CATEGORY = TestCategory.
-#   PID = 'SEARCH_DOMAIN'
-# TODO(peter): Test get
+class GetSearchDomain(TestMixins.GetStringMixin,
+                      OptionalParameterTestFixture):
+  CATEGORY = TestCategory.E133_MANAGEMENT
+  PID = 'SEARCH_DOMAIN'
+  EXPECTED_FIELDS = ['search_domain']
+  PROVIDES = ['search_domain']
+  MAX_LENGTH = RDM_MAX_SEARCH_DOMAIN_LENGTH
+  # TODO(Peter): Validate invalid search domains?
 
 
 class GetSearchDomainWithData(TestMixins.GetWithDataMixin,
@@ -8473,7 +8477,7 @@ class GetSearchDomainWithData(TestMixins.GetWithDataMixin,
 
 # class SetSearchDomain(TestMixins.,
 #                       OptionalParameterTestFixture):
-#   CATEGORY = TestCategory.
+#   CATEGORY = TestCategory.E133_MANAGEMENT
 #   PID = 'SEARCH_DOMAIN'
 # TODO(peter): Test set
 
@@ -8484,12 +8488,6 @@ class SetSearchDomainWithNoData(TestMixins.SetWithNoDataMixin,
   PID = 'SEARCH_DOMAIN'
 
 
-class SetSearchDomainWithExtraData(TestMixins.SetWithDataMixin,
-                                   OptionalParameterTestFixture):
-  """Send a SET SEARCH_DOMAIN command with extra data."""
-  PID = 'SEARCH_DOMAIN'
-
-
 class AllSubDevicesGetBrokerStatus(TestMixins.AllSubDevicesGetMixin,
                                    OptionalParameterTestFixture):
   """Send a get BROKER_STATUS to ALL_SUB_DEVICES."""
@@ -8498,7 +8496,7 @@ class AllSubDevicesGetBrokerStatus(TestMixins.AllSubDevicesGetMixin,
 
 # class GetBrokerStatus(TestMixins.,
 #                       OptionalParameterTestFixture):
-#   CATEGORY = TestCategory.
+#   CATEGORY = TestCategory.E133_MANAGEMENT
 #   PID = 'BROKER_STATUS'
 # TODO(peter): Test get
 
@@ -8511,7 +8509,7 @@ class GetBrokerStatusWithData(TestMixins.GetWithDataMixin,
 
 # class SetBrokerStatus(TestMixins.,
 #                       OptionalParameterTestFixture):
-#   CATEGORY = TestCategory.
+#   CATEGORY = TestCategory.E133_MANAGEMENT
 #   PID = 'BROKER_STATUS'
 # TODO(peter): Test set
 

tools/rdm/list_rdm_tests.py

@@ -24,6 +24,8 @@
 import sys
 import textwrap
 
+from ola.RDMConstants import RDM_MAX_PARAM_DATA_LENGTH
+
 from ola import PidStore
 
 __author__ = 'Peter Newman'
@@ -152,20 +154,22 @@ def GetWithExtraData(names, pid, pid_test_base_name, get_size):
     print('  """GET %s with more than %d byte%s of data."""' %
           (pid.name, get_size, 's' if get_size > 1 else ''))
     print('  PID = \'%s\'' % (pid.name))
+    if get_size >= RDM_MAX_PARAM_DATA_LENGTH:
+      print(("  # TODO(%s): Should we even have this test, get_size is "
+             "already at least the max PDL!") % (getpass.getuser()))
     dummy_data = GenerateDummyData(get_size)
     if dummy_data is None:
       print(("  # DATA = b'foo'  # TODO(%s): Specify extra data if this isn't "
              "enough.") % (getpass.getuser()))
-      print("  # Ensure the first %d bytes are sane/valid." % (get_size))
     elif dummy_data != 'foo':
       # Doesn't match default, explicitly set value
       print(("  DATA = b'%s'  # TODO(%s): Specify extra data if this isn't "
              "enough.") % (dummy_data, getpass.getuser()))
-      print("  # Ensure the first %d bytes are sane/valid." % (get_size))
     else:
       print(("  # DATA = b'%s'  # TODO(%s): Specify extra data if this isn't "
              "enough.") % (dummy_data, getpass.getuser()))
-      print("  # Ensure the first %d bytes are sane/valid." % (get_size))
+
+    print("  # Ensure the first %d bytes are sane/valid." % (get_size))
     print('')
     print('')
 
@@ -279,20 +283,22 @@ def SetWithExtraData(names, pid, pid_test_base_name, set_size):
                          'OptionalParameterTestFixture'])
     print('  """Send a SET %s command with extra data."""' % (pid.name))
     print('  PID = \'%s\'' % (pid.name))
+    if set_size >= RDM_MAX_PARAM_DATA_LENGTH:
+      print(("  # TODO(%s): Should we even have this test, set_size is "
+             "already at least the max PDL!") % (getpass.getuser()))
     dummy_data = GenerateDummyData(set_size)
     if dummy_data is None:
       print(("  # DATA = b'foo'  # TODO(%s): Specify extra data if this isn't "
              "enough.") % (getpass.getuser()))
-      print("  # Ensure the first %d bytes are sane/valid." % (set_size))
     elif dummy_data != 'foo':
       # Doesn't match default, explicitly set value
       print(("  DATA = b'%s'  # TODO(%s): Specify extra data if this isn't "
              "enough.") % (dummy_data, getpass.getuser()))
-      print("  # Ensure the first %d bytes are sane/valid." % (set_size))
     else:
       print(("  # DATA = b'%s'  # TODO(%s): Specify extra data if this isn't "
              "enough.") % (dummy_data, getpass.getuser()))
-      print("  # Ensure the first %d bytes are sane/valid." % (set_size))
+
+    print("  # Ensure the first %d bytes are sane/valid." % (set_size))
     print('')
     print('')