Make tests backwards compatible down to lua libs v10

Add backwards compatibility for matter switch test cases down to lua
libs version v10. Most of the issues were from test cases expecting
native handler registrations, which was added in v11. Also, running the
test cases against lower lua libs caught a bug in the driver code for
lua libs version v10 and lower, which prevented the energyMeter
capability from being emitted. This is also fixed by this PR.

It might be possible to extend support to even lower versions, but there
are a few additional api changes that would need to be accounted for.

Also note that to run these tests against lower versions, any
capabilities that are not available in that version of the lua libs
would need to be manually added to prevent test failures.

Author: nickolas-deboom

drivers/SmartThings/matter-switch/src/init.lua

@@ -1114,6 +1114,9 @@ local function occupancy_attr_handler(driver, device, ib, response)
 end
 
 local function cumul_energy_imported_handler(driver, device, ib, response)
+  if ib.data and version.api < 11 then
+    clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct:augment_type(ib.data)
+  end
   if ib.data.elements.energy then
     local watt_hour_value = ib.data.elements.energy.value / CONVERSION_CONST_MILLIWATT_TO_WATT
     device:set_field(TOTAL_IMPORTED_ENERGY, watt_hour_value, {persist = true})
@@ -1127,6 +1130,9 @@ local function cumul_energy_imported_handler(driver, device, ib, response)
 end
 
 local function per_energy_imported_handler(driver, device, ib, response)
+  if ib.data and version.api < 11 then
+    clusters.ElectricalEnergyMeasurement.types.EnergyMeasurementStruct:augment_type(ib.data)
+  end
   if ib.data.elements.energy then
     local watt_hour_value = ib.data.elements.energy.value / CONVERSION_CONST_MILLIWATT_TO_WATT
     local latest_energy_report = device:get_field(TOTAL_IMPORTED_ENERGY) or 0

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

@@ -1,4 +1,4 @@
--- Copyright 2024 SmartThings
+-- Copyright 2025 SmartThings
 --
 -- Licensed under the Apache License, Version 2.0 (the "License");
 -- you may not use this file except in compliance with the License.
@@ -17,11 +17,13 @@ local t_utils = require "integration_test.utils"
 local capabilities = require "st.capabilities"
 local utils = require "st.utils"
 local dkjson = require "dkjson"
-
 local clusters = require "st.matter.clusters"
 local button_attr = capabilities.button.button
-
-local DEFERRED_CONFIGURE = "__DEFERRED_CONFIGURE"
+local version = require "version"
+if version.api < 11 then
+  clusters.ElectricalEnergyMeasurement = require "ElectricalEnergyMeasurement"
+  clusters.ElectricalPowerMeasurement = require "ElectricalPowerMeasurement"
+end
 
 local aqara_parent_ep = 4
 local aqara_child1_ep = 1
@@ -208,7 +210,6 @@ local function test_init()
   test.mock_devices_api._expected_device_updates[1] = {device_id = "00000000-1111-2222-3333-000000000001"}
   test.mock_devices_api._expected_device_updates[1].metadata = {deviceId="00000000-1111-2222-3333-000000000001", profileReference="4-button"}
 
-  aqara_mock_device:set_field(DEFERRED_CONFIGURE, true, opts)
   local device_info_copy = utils.deep_copy(aqara_mock_device.raw_st_data)
   device_info_copy.profile.id = "4-button"
   local device_info_json = dkjson.encode(device_info_copy)

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

@@ -1,4 +1,4 @@
--- Copyright 2024 SmartThings
+-- Copyright 2025 SmartThings
 --
 -- Licensed under the Apache License, Version 2.0 (the "License");
 -- you may not use this file except in compliance with the License.
@@ -15,11 +15,12 @@
 local test = require "integration_test"
 local capabilities = require "st.capabilities"
 local t_utils = require "integration_test.utils"
-
 local clusters = require "st.matter.clusters"
-
-clusters.ElectricalEnergyMeasurement = require "ElectricalEnergyMeasurement"
-clusters.ElectricalPowerMeasurement = require "ElectricalPowerMeasurement"
+local version = require "version"
+if version.api < 11 then
+  clusters.ElectricalEnergyMeasurement = require "ElectricalEnergyMeasurement"
+  clusters.ElectricalPowerMeasurement = require "ElectricalPowerMeasurement"
+end
 
 local mock_device = test.mock_device.build_test_matter_device({
   profile = t_utils.get_profile_definition("plug-level-power-energy-powerConsumption.yml"),
@@ -183,64 +184,54 @@ test.register_coroutine_test(
   end
 )
 
-test.register_message_test(
-	"On command should send the appropriate commands",
-  {
-    channel = "devices",
-    direction = "send",
-    message = {
-      "register_native_capability_cmd_handler",
-      { device_uuid = mock_device.id, capability_id = "switch", capability_cmd_id = "on" }
-    }
-  },
-	{
-		{
-			channel = "capability",
-			direction = "receive",
-			message = {
-				mock_device.id,
-				{ capability = "switch", component = "main", command = "on", args = { } }
-			}
-		},
-		{
-			channel = "matter",
-			direction = "send",
-			message = {
-				mock_device.id,
-				clusters.OnOff.server.commands.On(mock_device, 2)
-			}
-		}
-	}
+test.register_coroutine_test(
+  "On command should send the appropriate commands", function()
+    test.socket.capability:__queue_receive(
+      {
+        mock_device.id,
+        { capability = "switch", component = "main", command = "on", args = { } }
+      }
+    )
+    if version.api >= 11 then
+      test.socket.devices:__expect_send(
+        {
+          "register_native_capability_cmd_handler",
+          { device_uuid = mock_device.id, capability_id = "switch", capability_cmd_id = "on" }
+        }
+      )
+    end
+    test.socket.matter:__expect_send(
+      {
+        mock_device.id,
+        clusters.OnOff.server.commands.On(mock_device, 2)
+      }
+    )
+  end
 )
 
-test.register_message_test(
-  "Off command should send the appropriate commands",
-  {
-    channel = "devices",
-    direction = "send",
-    message = {
-      "register_native_capability_cmd_handler",
-      { device_uuid = mock_device.id, capability_id = "switch", capability_cmd_id = "off" }
-    }
-  },
-  {
-    {
-      channel = "capability",
-      direction = "receive",
-      message = {
+test.register_coroutine_test(
+  "Off command should send the appropriate commands", function()
+    test.socket.capability:__queue_receive(
+      {
         mock_device.id,
         { capability = "switch", component = "main", command = "off", args = { } }
       }
-    },
-    {
-      channel = "matter",
-      direction = "send",
-      message = {
+    )
+    if version.api >= 11 then
+      test.socket.devices:__expect_send(
+        {
+          "register_native_capability_cmd_handler",
+          { device_uuid = mock_device.id, capability_id = "switch", capability_cmd_id = "off" }
+        }
+      )
+    end
+    test.socket.matter:__expect_send(
+      {
         mock_device.id,
         clusters.OnOff.server.commands.Off(mock_device, 2)
       }
-    }
-  }
+    )
+  end
 )
 
 test.register_message_test(
@@ -681,68 +672,57 @@ test.register_coroutine_test(
   { test_init = test_init_periodic }
 )
 
-test.register_message_test(
-  "Set level command should send the appropriate commands",
-  {
-    {
-      channel = "capability",
-      direction = "receive",
-      message = {
+test.register_coroutine_test(
+  "Set level command should send the appropriate commands", function()
+    test.socket.capability:__queue_receive(
+      {
         mock_device.id,
         { capability = "switchLevel", component = "main", command = "setLevel", args = {20,20} }
       }
-    },
-    {
-      channel = "devices",
-      direction = "send",
-      message = {
-        "register_native_capability_cmd_handler",
-        { device_uuid = mock_device.id, capability_id = "switchLevel", capability_cmd_id = "setLevel" }
-      }
-    },
-    {
-      channel = "matter",
-      direction = "send",
-      message = {
+    )
+    if version.api >= 11 then
+      test.socket.devices:__expect_send(
+        {
+          "register_native_capability_cmd_handler",
+          { device_uuid = mock_device.id, capability_id = "switchLevel", capability_cmd_id = "setLevel" }
+        }
+      )
+    end
+    test.socket.matter:__expect_send(
+      {
         mock_device.id,
         clusters.LevelControl.server.commands.MoveToLevelWithOnOff(mock_device, 2, math.floor(20/100.0 * 254), 20, 0 ,0)
       }
-    },
-    {
-      channel = "matter",
-      direction = "receive",
-      message = {
+    )
+    test.socket.matter:__queue_receive(
+      {
         mock_device.id,
         clusters.LevelControl.server.commands.MoveToLevelWithOnOff:build_test_command_response(mock_device, 2)
       }
-    },
-    {
-      channel = "matter",
-      direction = "receive",
-      message = {
+    )
+    test.socket.matter:__queue_receive(
+      {
         mock_device.id,
         clusters.LevelControl.attributes.CurrentLevel:build_test_report_data(mock_device, 2, 50)
       }
-    },
-    {
-      channel = "capability",
-      direction = "send",
-      message = mock_device:generate_test_message("main", capabilities.switchLevel.level(20))
-    },
-    {
-      channel = "matter",
-      direction = "receive",
-      message = {
+    )
+    test.socket.capability:__expect_send(
+      mock_device:generate_test_message(
+        "main", capabilities.switchLevel.level(20)
+      )
+    )
+    test.socket.matter:__queue_receive(
+      {
         mock_device.id,
         clusters.OnOff.attributes.OnOff:build_test_report_data(mock_device, 2, true)
       }
-    },
-    {
-      channel = "capability",
-      direction = "send",
-      message = mock_device:generate_test_message("main", capabilities.switch.switch.on())
-    }
-  }
+    )
+    test.socket.capability:__expect_send(
+      mock_device:generate_test_message(
+        "main", capabilities.switch.switch.on()
+      )
+    )
+  end
 )
 
 test.run_registered_tests()