Add the TEST_DATA PID and some responder tests for it

Author: peternewman

common/rdm/DummyResponder.cpp

@@ -169,6 +169,9 @@ const ResponderOps<DummyResponder>::ParamHandler
   { PID_FIRMWARE_URL,
     &DummyResponder::GetFirmwareURL,
     NULL},
+  { PID_TEST_DATA,
+    &DummyResponder::GetTestData,
+    &DummyResponder::SetTestData},
   { OLA_MANUFACTURER_PID_CODE_VERSION,
     &DummyResponder::GetOlaCodeVersion,
     NULL},
@@ -469,6 +472,14 @@ RDMResponse *DummyResponder::GetFirmwareURL(
       UINT8_MAX); // TODO(Peter): This field's length isn't limited in the spec
 }
 
+RDMResponse *DummyResponder::GetTestData(const RDMRequest *request) {
+  return ResponderHelper::GetTestData(request);
+}
+
+RDMResponse *DummyResponder::SetTestData(const RDMRequest *request) {
+  return ResponderHelper::SetTestData(request);
+}
+
 RDMResponse *DummyResponder::GetOlaCodeVersion(
     const RDMRequest *request) {
   return ResponderHelper::GetString(request, VERSION);

common/rdm/ResponderHelper.cpp

@@ -1072,6 +1072,44 @@ RDMResponse *ResponderHelper::GetIPV4Address(
                         queued_message_count);
 }
 
+RDMResponse *ResponderHelper::GetTestData(
+    const RDMRequest *request,
+    uint8_t queued_message_count) {
+  uint16_t pattern_length;
+  if (!ExtractUInt16(request, &pattern_length)) {
+    return NackWithReason(request, NR_FORMAT_ERROR, queued_message_count);
+  }
+
+  if (pattern_length > MAX_RDM_TEST_DATA_PATTERN_LENGTH) {
+    return NackWithReason(request, NR_DATA_OUT_OF_RANGE, queued_message_count);
+  }
+
+  uint8_t pattern_data[pattern_length];
+
+  for (unsigned int i = 0; i < pattern_length; i++) {
+    // Need to return values 0-255, 0... etc
+    pattern_data[i] = i % (UINT8_MAX + 1);
+  }
+
+  return GetResponseFromData(
+      request,
+      reinterpret_cast<uint8_t*>(&pattern_data),
+      sizeof(pattern_data),
+      RDM_ACK,
+      queued_message_count);
+}
+
+RDMResponse *ResponderHelper::SetTestData(
+    const RDMRequest *request,
+    uint8_t queued_message_count) {
+  return GetResponseFromData(
+      request,
+      request->ParamData(),
+      request->ParamDataSize(),
+      RDM_ACK,
+      queued_message_count);
+}
+
 RDMResponse *ResponderHelper::GetListTags(
     const RDMRequest *request,
     const TagSet *tag_set,

include/ola/rdm/RDMEnums.h

@@ -759,13 +759,17 @@ static const uint8_t MAX_RDM_DOMAIN_NAME_LENGTH = 231;
 static const uint8_t DNS_NAME_SERVER_MAX_INDEX = 2;
 
 // Consts for E1.37-5
+static const uint16_t MAX_RDM_TEST_DATA_PATTERN_LENGTH = 4096;
+
 // The shipping lock states
 typedef enum {
   SHIPPING_LOCK_STATE_UNLOCKED = 0x00,
   SHIPPING_LOCK_STATE_LOCKED = 0x01,
   SHIPPING_LOCK_STATE_PARTIALLY_LOCKED = 0x02,
 } rdm_shipping_lock_state;
 
+static const uint8_t MAX_RDM_SERIAL_NUMBER_LENGTH = 231;
+
 // Excluding the mandatory NULL terminator
 static const uint8_t MAX_RDM_SCOPE_STRING_LENGTH = 62;
 }  // namespace rdm

include/ola/rdm/ResponderHelper.h

@@ -218,6 +218,14 @@ class ResponderHelper {
         uint8_t queued_message_count = 0);
 
     // E1.37-5 Helpers
+    static RDMResponse *GetTestData(
+        const RDMRequest *request,
+        uint8_t queued_message_count = 0);
+
+    static RDMResponse *SetTestData(
+        const RDMRequest *request,
+        uint8_t queued_message_count = 0);
+
     static RDMResponse *GetListTags(
         const RDMRequest *request,
         const TagSet *tag_set,

python/ola/RDMConstants.py

@@ -41,6 +41,7 @@
 
 RDM_MAX_SERIAL_NUMBER_LENGTH = 231
 
+RDM_MAX_TEST_DATA_PATTERN_LENGTH = 4096
 
 def _ReverseDict(input):
   output = {}

tools/rdm/TestDefinitions.py

@@ -29,6 +29,7 @@
                               RDM_MAX_DOMAIN_NAME_LENGTH,
                               RDM_MAX_HOSTNAME_LENGTH,
                               RDM_MAX_SERIAL_NUMBER_LENGTH,
+                              RDM_MAX_TEST_DATA_PATTERN_LENGTH,
                               RDM_MIN_HOSTNAME_LENGTH,
                               RDM_ZERO_FOOTPRINT_DMX_ADDRESS)
 from ola.StringUtils import StringEscape
@@ -8143,6 +8144,38 @@ class SetSerialNumberWithData(TestMixins.UnsupportedSetWithDataMixin,
   PID = 'SERIAL_NUMBER'
 
 
+class AllSubDevicesGetTestData(TestMixins.AllSubDevicesGetMixin,
+                               OptionalParameterTestFixture):
+  """Send a get TEST_DATA to ALL_SUB_DEVICES."""
+  PID = 'TEST_DATA'
+  DATA = [1]
+
+
+class GetTestDataWithNoData(TestMixins.GetWithNoDataMixin,
+                            OptionalParameterTestFixture):
+  """GET TEST_DATA with no argument given."""
+  PID = 'TEST_DATA'
+
+
+class GetTestDataWithExtraData(TestMixins.GetWithDataMixin,
+                               OptionalParameterTestFixture):
+  """GET TEST_DATA with more than 2 bytes of data."""
+  PID = 'TEST_DATA'
+  DATA = b'foo'
+  # TODO(peter): Ensure the first 2 bytes are sane/valid.
+
+
+class GetOutOfRangeTestData(OptionalParameterTestFixture):
+  """Get TEST_DATA with a pattern length of 4096 + 1."""
+  CATEGORY = TestCategory.ERROR_CONDITIONS
+  PID = 'TEST_DATA'
+
+  def Test(self):
+    self.AddIfGetSupported(self.NackGetResult(RDMNack.NR_DATA_OUT_OF_RANGE))
+    data = struct.pack('!H', (RDM_MAX_TEST_DATA_PATTERN_LENGTH + 1))
+    self.SendRawGet(ROOT_DEVICE, self.pid, data)
+
+
 class AllSubDevicesGetListTags(TestMixins.AllSubDevicesGetMixin,
                                OptionalParameterTestFixture):
   """Send a get LIST_TAGS to ALL_SUB_DEVICES."""

tools/rdm/list_rdm_tests.py

@@ -356,6 +356,7 @@ def main():
   for pid in pid_store.Pids():
     pid_test_base_name = pid.name.lower().title().replace('_', '')
 
+    # TODO(Peter): Need to do min and max size as some PIDs are variable length
     get_size = 0
     if ((pid.RequestSupported(PidStore.RDM_GET)) and
         (pid.GetRequest(PidStore.RDM_GET).HasAtoms())):