remove commented code, add and update tests

Author: hcarter-775

drivers/SmartThings/matter-switch/src/switch_utils/utils.lua

@@ -432,7 +432,6 @@ end
 --- @param checked_device any a Matter device object, either a parent or child device, so not necessarily the same as device
 --- @param subscribe_request table a subscribe request that will be appended to as needed for the device
 --- @param capabilities_seen any a list of capabilities that have already been checked by already checked devices
--- @param matter_elements_seen table a list of attribute and event ids that have been added already
 --- @param subscribed_attributes table key-value pairs mapping capability ids to subscribed attributes
 --- @param subscribed_events table key-value pairs mapping capability ids to subscribed events
 function utils.populate_subscribe_request_for_device(checked_device, subscribe_request, capabilities_seen, attributes_seen, events_seen, subscribed_attributes, subscribed_events)

drivers/SmartThings/matter-switch/src/test/test_matter_multi_button_switch_mcd.lua

@@ -166,7 +166,18 @@ local child_data = {
 local mock_child = test.mock_device.build_test_child_device(child_data)
 
 -- add device for each mock device
-local CLUSTER_SUBSCRIBE_LIST ={
+local CLUSTER_SUBSCRIBE_LIST_NO_CHILD ={
+  clusters.OnOff.attributes.OnOff,
+  clusters.LevelControl.attributes.CurrentLevel,
+  clusters.LevelControl.attributes.MaxLevel,
+  clusters.LevelControl.attributes.MinLevel,
+  clusters.Switch.server.events.InitialPress,
+  clusters.Switch.server.events.LongPress,
+  clusters.Switch.server.events.ShortRelease,
+  clusters.Switch.server.events.MultiPressComplete,
+}
+
+local CLUSTER_SUBSCRIBE_LIST_WITH_CHILD ={
   clusters.OnOff.attributes.OnOff,
   clusters.LevelControl.attributes.CurrentLevel,
   clusters.LevelControl.attributes.MaxLevel,
@@ -202,11 +213,10 @@ local function test_init()
   -- so we can set the proper expectations on those events.
   test.disable_startup_messages()
   test.mock_device.add_test_device(mock_device) -- make sure the cache is populated
-  test.mock_device.add_test_device(mock_child)
 
   -- added sets a bunch of fields on the device, and calls init
-  local subscribe_request = CLUSTER_SUBSCRIBE_LIST[1]:subscribe(mock_device)
-  for i, clus in ipairs(CLUSTER_SUBSCRIBE_LIST) do
+  local subscribe_request = CLUSTER_SUBSCRIBE_LIST_NO_CHILD[1]:subscribe(mock_device)
+  for i, clus in ipairs(CLUSTER_SUBSCRIBE_LIST_NO_CHILD) do
     if i > 1 then subscribe_request:merge(clus:subscribe(mock_device)) end
   end
   test.socket.matter:__expect_send({mock_device.id, subscribe_request})
@@ -350,63 +360,45 @@ test.register_coroutine_test(
   end
 )
 
-test.register_message_test(
+test.register_coroutine_test(
   "Switch child device: Set color temperature should send the appropriate commands",
-  {
-    {
-      channel = "capability",
-      direction = "receive",
-      message = {
-        mock_child.id,
-        { capability = "colorTemperature", component = "main", command = "setColorTemperature", args = {1800} }
-      }
-    },
-    {
-      channel = "matter",
-      direction = "send",
-      message = {
-        mock_device.id,
-        clusters.ColorControl.server.commands.MoveToColorTemperature(mock_device, mock_device_ep5, 556, TRANSITION_TIME, OPTIONS_MASK, OPTIONS_OVERRIDE)
-      }
-    },
-    {
-      channel = "matter",
-      direction = "receive",
-      message = {
-        mock_device.id,
-        clusters.ColorControl.server.commands.MoveToColorTemperature:build_test_command_response(mock_device, mock_device_ep5)
-      }
-    },
-    {
-      channel = "matter",
-      direction = "receive",
-      message = {
-        mock_device.id,
-        clusters.ColorControl.attributes.ColorTemperatureMireds:build_test_report_data(mock_device, mock_device_ep5, 556)
-      }
-    },
-    {
-      channel = "capability",
-      direction = "send",
-      message = mock_child:generate_test_message("main", capabilities.colorTemperature.colorTemperature(1800))
-    },
-  }
+  function()
+    test.mock_device.add_test_device(mock_child)
+    test.wait_for_events()
+    test.socket.capability:__queue_receive({
+      mock_child.id,
+      { capability = "colorTemperature", component = "main", command = "setColorTemperature", args = {1800} }
+    })
+    test.socket.matter:__expect_send({
+      mock_device.id,
+      clusters.ColorControl.server.commands.MoveToColorTemperature(mock_device, mock_device_ep5, 556, TRANSITION_TIME, OPTIONS_MASK, OPTIONS_OVERRIDE)
+    })
+    test.socket.matter:__queue_receive({
+      mock_device.id,
+      clusters.ColorControl.server.commands.MoveToColorTemperature:build_test_command_response(mock_device, mock_device_ep5)
+    })
+    test.wait_for_events()
+    test.socket.matter:__queue_receive({
+      mock_device.id,
+      clusters.ColorControl.attributes.ColorTemperatureMireds:build_test_report_data(mock_device, mock_device_ep5, 556)
+    })
+    test.socket.capability:__expect_send(mock_child:generate_test_message("main", capabilities.colorTemperature.colorTemperature(1800)))
+  end
 )
 
 test.register_coroutine_test(
   "Test MCD configuration not including switch for unsupported switch device type, create child device instead",
   function()
     local unsup_mock_device = mock_device_mcd_unsupported_switch_device_type
     -- added sets a bunch of fields on the device, and calls init
-    local cluster_subscribe_list = {
-      -- clusters.OnOff.attributes.OnOff,
+    local CLUSTER_SUBSCRIBE_LIST = {
       clusters.Switch.server.events.InitialPress,
       clusters.Switch.server.events.LongPress,
       clusters.Switch.server.events.ShortRelease,
       clusters.Switch.server.events.MultiPressComplete,
     }
-    local subscribe_request = cluster_subscribe_list[1]:subscribe(unsup_mock_device)
-    for _, cluster in ipairs(cluster_subscribe_list) do
+    local subscribe_request = CLUSTER_SUBSCRIBE_LIST[1]:subscribe(unsup_mock_device)
+    for _, cluster in ipairs(CLUSTER_SUBSCRIBE_LIST) do
       subscribe_request:merge(cluster:subscribe(unsup_mock_device))
     end
     test.socket.device_lifecycle:__queue_receive({ unsup_mock_device.id, "added" })
@@ -433,15 +425,14 @@ test.register_coroutine_test(
     local updated_device_profile = t_utils.get_profile_definition("2-button.yml")
     test.socket.device_lifecycle:__queue_receive(unsup_mock_device:generate_info_changed({ profile = updated_device_profile }))
 
-    local cluster_subscribe_list = {
-      -- clusters.OnOff.attributes.OnOff,
+    local CLUSTER_SUBSCRIBE_LIST = {
       clusters.Switch.server.events.InitialPress,
       clusters.Switch.server.events.LongPress,
       clusters.Switch.server.events.ShortRelease,
       clusters.Switch.server.events.MultiPressComplete,
     }
-    local subscribe_request = cluster_subscribe_list[1]:subscribe(unsup_mock_device)
-    for i, cluster in ipairs(cluster_subscribe_list) do
+    local subscribe_request = CLUSTER_SUBSCRIBE_LIST[1]:subscribe(unsup_mock_device)
+    for i, cluster in ipairs(CLUSTER_SUBSCRIBE_LIST) do
       if i > 1 then
         subscribe_request:merge(cluster:subscribe(unsup_mock_device))
       end
@@ -474,11 +465,11 @@ test.register_coroutine_test(
 )
 
 test.register_coroutine_test(
-  "Test infoChanged event",
+  "Test infoChanged event for parent device",
   function ()
     -- simulate the profile change update taking affect and the device info changing
-    local subscribe_request = CLUSTER_SUBSCRIBE_LIST[1]:subscribe(mock_device)
-    for i, clus in ipairs(CLUSTER_SUBSCRIBE_LIST) do
+    local subscribe_request = CLUSTER_SUBSCRIBE_LIST_NO_CHILD[1]:subscribe(mock_device)
+    for i, clus in ipairs(CLUSTER_SUBSCRIBE_LIST_NO_CHILD) do
       if i > 1 then subscribe_request:merge(clus:subscribe(mock_device)) end
     end
     local device_info_copy = utils.deep_copy(mock_device.raw_st_data)
@@ -487,9 +478,20 @@ test.register_coroutine_test(
     test.socket.matter:__expect_send({mock_device.id, subscribe_request})
     expect_configure_buttons()
     test.socket.device_lifecycle:__queue_receive({ mock_device.id, "infoChanged", device_info_json })
+  end
+)
+
+test.register_coroutine_test(
+  "Test child device initialization, and that subscriptions are initialized correctly",
+  function ()
+    test.mock_device.add_test_device(mock_child)
     test.socket.matter:__expect_send({mock_device.id, clusters.OnOff.attributes.OnOff:read(mock_device)})
     test.socket.device_lifecycle:__queue_receive({ mock_child.id, "added" })
     test.socket.device_lifecycle:__queue_receive({ mock_child.id, "init" })
+    local subscribe_request = CLUSTER_SUBSCRIBE_LIST_WITH_CHILD[1]:subscribe(mock_device)
+    for i, clus in ipairs(CLUSTER_SUBSCRIBE_LIST_WITH_CHILD) do
+      if i > 1 then subscribe_request:merge(clus:subscribe(mock_device)) end
+    end
     test.socket.matter:__expect_send({mock_device.id, subscribe_request})
     mock_child:expect_metadata_update({ provisioning_state = "PROVISIONED" })
     test.socket.device_lifecycle:__queue_receive({ mock_child.id, "doConfigure" })

drivers/SmartThings/matter-switch/src/test/test_matter_switch_device_types.lua

@@ -584,25 +584,9 @@ end
 local function test_init_parent_child_different_types()
   test.mock_device.add_test_device(mock_device_parent_child_different_types)
   local cluster_subscribe_list = {
-    clusters.OnOff.attributes.OnOff,
-    -- clusters.LevelControl.attributes.CurrentLevel,
-    -- clusters.LevelControl.attributes.MaxLevel,
-    -- clusters.LevelControl.attributes.MinLevel,
-    -- clusters.ColorControl.attributes.ColorTemperatureMireds,
-    -- clusters.ColorControl.attributes.ColorTempPhysicalMaxMireds,
-    -- clusters.ColorControl.attributes.ColorTempPhysicalMinMireds,
-    -- clusters.ColorControl.attributes.CurrentHue,
-    -- clusters.ColorControl.attributes.CurrentSaturation,
-    -- clusters.ColorControl.attributes.CurrentX,
-    -- clusters.ColorControl.attributes.CurrentY,
-    -- clusters.ColorControl.attributes.ColorMode,
+    clusters.OnOff.attributes.OnOff
   }
   local subscribe_request = cluster_subscribe_list[1]:subscribe(mock_device_parent_child_different_types)
-  for i, cluster in ipairs(cluster_subscribe_list) do
-    if i > 1 then
-      subscribe_request:merge(cluster:subscribe(mock_device_parent_child_different_types))
-    end
-  end
   test.socket.device_lifecycle:__queue_receive({ mock_device_parent_child_different_types.id, "added" })
   test.socket.matter:__expect_send({mock_device_parent_child_different_types.id, subscribe_request})