uic: zpc: Pull request #2931: UIC-3603: zwave module unit test

silabs-aydogane · rzr · commit 1bb69e5fa10e · 2025-02-04T15:23:16.000+01:00
Merge in UIC/uic from test/UIC-3603-zwave-module-unit-test to develop (cherry picked from commit c2296d353cc5498237924a37cb76880d55de3292) Forwarded: #11 Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
diff --git a/applications/zpc/components/zwave/zwave_controller/test/zwave_controller_callbacks_test.c b/applications/zpc/components/zwave/zwave_controller/test/zwave_controller_callbacks_test.c
@@ -22,17 +22,21 @@
 #include "sl_log.h"
 
 /// Static variables
-static zwave_controller_callbacks_t callbacks                   = {};
-static int zwave_controller_on_frame_transmission_call_count    = 0;
-static int zwave_controller_on_node_event_test_call_count       = 0;
-static int zwave_controller_on_rx_frame_received_count          = 0;
-static int zwave_controller_on_network_address_update_count     = 0;
-static int zwave_controller_on_application_frame_received_count = 0;
-static zwave_controller_connection_info_t info                  = {};
-static zwave_rx_receive_options_t rx_options                    = {};
-const uint8_t frame_data[]                                      = {0x00};
-const uint8_t transport_frame_data[]                            = {0xbb};
-static sl_status_t transport_return_code                        = SL_STATUS_OK;
+static zwave_controller_callbacks_t callbacks                       = {};
+static int zwave_controller_on_frame_transmission_call_count        = 0;
+static int zwave_controller_on_node_event_test_call_count           = 0;
+static int zwave_controller_on_rx_frame_received_count              = 0;
+static int zwave_controller_on_network_address_update_count         = 0;
+static int zwave_controller_on_application_frame_received_count     = 0;
+static int zwave_controller_on_protocol_cc_encryption_request_count = 0;
+static int zwave_controller_on_protocol_frame_received_count        = 0;
+static zwave_controller_connection_info_t info                      = {};
+static zwave_rx_receive_options_t rx_options                        = {};
+const uint8_t frame_data[]                                          = {0x00};
+const uint8_t protocol_frame_data[]    = {0x01};  // ZWAVE_CMD_CLASS_PROTOCOL
+const uint8_t protocol_lr_frame_data[] = {0x04};  // ZWAVE_CMD_CLASS_PROTOCOL_LR
+const uint8_t transport_frame_data[]   = {0xbb};
+static sl_status_t transport_return_code = SL_STATUS_OK;
 
 // A Z-Wave Controller transport:
 static sl_status_t test_transport_on_frame_received(
@@ -82,6 +86,27 @@ static void zwave_controller_on_application_frame_received(
   zwave_controller_on_application_frame_received_count += 1;
 }
 
+static void zwave_controller_on_protocol_cc_encryption_request(
+  const zwave_node_id_t destination_node_id,
+  const uint8_t payload_length,
+  const uint8_t *const payload,
+  const uint8_t protocol_metadata_length,
+  const uint8_t *const protocol_metadata,
+  const uint8_t use_supervision,
+  const uint8_t session_id)
+{
+  zwave_controller_on_protocol_cc_encryption_request_count += 1;
+}
+
+static void zwave_controller_on_protocol_frame_received(
+  const zwave_controller_connection_info_t *connection_info,
+  const zwave_rx_receive_options_t *rx_options,
+  const uint8_t *frame_data,
+  uint16_t frame_length)
+{
+  zwave_controller_on_protocol_frame_received_count += 1;
+}
+
 static void zwave_controller_on_node_event_test(zwave_node_id_t node_id)
 {
   zwave_controller_on_node_event_test_call_count += 1;
@@ -102,12 +127,14 @@ int suiteTearDown(int num_failures)
 
 void setUp()
 {
-  zwave_controller_on_frame_transmission_call_count    = 0;
-  zwave_controller_on_node_event_test_call_count       = 0;
-  zwave_controller_on_rx_frame_received_count          = 0;
-  zwave_controller_on_network_address_update_count     = 0;
-  zwave_controller_on_application_frame_received_count = 0;
-  transport_return_code                                = SL_STATUS_OK;
+  zwave_controller_on_frame_transmission_call_count        = 0;
+  zwave_controller_on_node_event_test_call_count           = 0;
+  zwave_controller_on_rx_frame_received_count              = 0;
+  zwave_controller_on_network_address_update_count         = 0;
+  zwave_controller_on_application_frame_received_count     = 0;
+  zwave_controller_on_protocol_cc_encryption_request_count = 0;
+  zwave_controller_on_protocol_frame_received_count        = 0;
+  transport_return_code                                    = SL_STATUS_OK;
   zwave_controller_callbacks_init();
 }
 
@@ -266,6 +293,125 @@ void test_zwave_controller_on_controller_application_frames()
   callbacks.on_application_frame_received = NULL;
 }
 
+void test_zwave_controller_on_protocol_cc_encryption_request_received()
+{
+  zwave_node_id_t destination_node_id = 3;
+  uint8_t payload[]                   = {0xF1, 0xF2};
+  uint8_t payload_length              = sizeof(payload);
+  uint8_t protocol_metadata[]         = {0x1E, 0x2E};
+  uint8_t protocol_metadata_length    = sizeof(protocol_metadata);
+  uint8_t use_supervision             = 1;
+  uint8_t session_id                  = 2;
+
+  zwave_controller_on_protocol_cc_encryption_request_received(
+    destination_node_id,
+    payload_length,
+    payload,
+    protocol_metadata_length,
+    protocol_metadata,
+    use_supervision,
+    session_id);
+  TEST_ASSERT_EQUAL(0,
+                    zwave_controller_on_protocol_cc_encryption_request_count);
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_application_frame_received_count);
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_rx_frame_received_count);
+
+  callbacks.on_rx_frame_received
+    = &zwave_controller_on_rx_frame_received_callback;
+  callbacks.on_application_frame_received
+    = &zwave_controller_on_application_frame_received;
+  callbacks.on_protocol_cc_encryption_request
+    = &zwave_controller_on_protocol_cc_encryption_request;
+  TEST_ASSERT_EQUAL(SL_STATUS_OK,
+                    zwave_controller_register_callbacks(&callbacks));
+
+  zwave_controller_on_protocol_cc_encryption_request_received(
+    destination_node_id,
+    payload_length,
+    payload,
+    protocol_metadata_length,
+    protocol_metadata,
+    use_supervision,
+    session_id);
+  TEST_ASSERT_EQUAL(1,
+                    zwave_controller_on_protocol_cc_encryption_request_count);
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_application_frame_received_count);
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_rx_frame_received_count);
+
+  // remove these callbacks:
+  callbacks.on_rx_frame_received              = NULL;
+  callbacks.on_application_frame_received     = NULL;
+  callbacks.on_protocol_cc_encryption_request = NULL;
+}
+
+void test_zwave_controller_on_controller_protocol_frames()
+{
+  // We need to inject a valid frame, as this will go through the transports
+  zwave_controller_on_frame_received(&info,
+                                     &rx_options,
+                                     protocol_frame_data,
+                                     sizeof(protocol_frame_data));
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_protocol_frame_received_count);
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_rx_frame_received_count);
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_application_frame_received_count);
+
+  callbacks.on_rx_frame_received
+    = &zwave_controller_on_rx_frame_received_callback;
+  callbacks.on_application_frame_received
+    = &zwave_controller_on_application_frame_received;
+  callbacks.on_protocol_frame_received
+    = &zwave_controller_on_protocol_frame_received;
+  TEST_ASSERT_EQUAL(SL_STATUS_OK,
+                    zwave_controller_register_callbacks(&callbacks));
+
+  zwave_controller_on_frame_received(&info,
+                                     &rx_options,
+                                     protocol_frame_data,
+                                     sizeof(protocol_frame_data));
+  TEST_ASSERT_EQUAL(1, zwave_controller_on_protocol_frame_received_count);
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_application_frame_received_count);
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_rx_frame_received_count);
+
+  // remove these callbacks:
+  callbacks.on_rx_frame_received          = NULL;
+  callbacks.on_application_frame_received = NULL;
+  callbacks.on_protocol_frame_received    = NULL;
+}
+
+void test_zwave_controller_on_controller_protocol_lr_frames()
+{
+  // We need to inject a valid frame, as this will go through the transports
+  zwave_controller_on_frame_received(&info,
+                                     &rx_options,
+                                     protocol_lr_frame_data,
+                                     sizeof(protocol_lr_frame_data));
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_protocol_frame_received_count);
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_rx_frame_received_count);
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_application_frame_received_count);
+
+  callbacks.on_rx_frame_received
+    = &zwave_controller_on_rx_frame_received_callback;
+  callbacks.on_application_frame_received
+    = &zwave_controller_on_application_frame_received;
+  callbacks.on_protocol_frame_received
+    = &zwave_controller_on_protocol_frame_received;
+  TEST_ASSERT_EQUAL(SL_STATUS_OK,
+                    zwave_controller_register_callbacks(&callbacks));
+
+  zwave_controller_on_frame_received(&info,
+                                     &rx_options,
+                                     protocol_lr_frame_data,
+                                     sizeof(protocol_lr_frame_data));
+  TEST_ASSERT_EQUAL(1, zwave_controller_on_protocol_frame_received_count);
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_application_frame_received_count);
+  TEST_ASSERT_EQUAL(0, zwave_controller_on_rx_frame_received_count);
+
+  // remove these callbacks:
+  callbacks.on_rx_frame_received          = NULL;
+  callbacks.on_application_frame_received = NULL;
+  callbacks.on_protocol_frame_received    = NULL;
+}
+
 void test_zwave_controller_on_network_address_update()
 {
   // Nothing happens with no callback registered
diff --git a/applications/zpc/components/zwave/zwave_controller/test/zwave_controller_test.c b/applications/zpc/components/zwave/zwave_controller/test/zwave_controller_test.c
@@ -17,6 +17,7 @@
 #include "zpc_config_mock.h"
 #include "zwapi_protocol_basis_mock.h"
 #include "zwave_s2_transport_mock.h"
+#include "zwapi_protocol_controller_mock.h"
 
 /// Setup the test suite (called once before all test_xxx functions are called)
 void suiteSetUp() {}
@@ -68,4 +69,20 @@ void test_zwave_controller_set_secure_nif()
 
   zwave_controller_set_secure_application_nif(command_classes,
                                               sizeof(command_classes));
-}
+}
+
+void test_zwave_controller_request_protocol_cc_encryption_callback()
+{
+  uint8_t status                  = TRANSMIT_COMPLETE_VERIFIED;
+  zwapi_tx_report_t tx_info       = {0};
+  uint8_t session_id              = 0;
+
+  zwapi_request_protocol_cc_encryption_callback_ExpectAndReturn(status,
+                                                                &tx_info,
+                                                                session_id,
+                                                                SL_STATUS_OK);
+
+  zwave_controller_request_protocol_cc_encryption_callback(status,
+                                                           &tx_info,
+                                                           session_id);
+}
diff --git a/applications/zpc/components/zwave/zwave_rx/test/zwave_rx_test.c b/applications/zpc/components/zwave/zwave_rx/test/zwave_rx_test.c
@@ -437,6 +437,47 @@ void test_zwave_rx_on_frame_received()
   TEST_ASSERT_EQUAL(0, zwave_rx_fixt_teardown());
 }
 
+void test_zwave_rx_on_protocol_cc_encryption_request_received()
+{
+  // Init zwave_rx:
+  rx_init_successful_test_helper();
+
+  zwave_node_id_t destination_node_id = 3;
+  uint8_t payload[]                   = {0x01, 0x02};
+  uint8_t payload_length              = sizeof(payload);
+  uint8_t metadata[]                  = {0xA1, 0xA2};
+  uint8_t metadata_length             = sizeof(metadata);
+  uint8_t use_supervision             = 1;
+  uint8_t session_id                  = 2;
+
+  // Frame dispatch
+  zwave_controller_on_protocol_cc_encryption_request_received_ExpectWithArray(
+    destination_node_id,
+    payload_length,
+    payload,
+    payload_length,
+    metadata_length,
+    metadata,
+    metadata_length,
+    use_supervision,
+    session_id);
+
+  // Trigger an on_frame_received callback
+  registered_zwapi_callbacks->protocol_cc_encryption_request(
+    destination_node_id,
+    payload_length,
+    payload,
+    metadata_length,
+    metadata,
+    use_supervision,
+    session_id);
+
+  // Now shut down the functionality
+  zwapi_destroy_Expect();
+  zwapi_log_to_file_disable_ExpectAndReturn(SL_STATUS_OK);
+  TEST_ASSERT_EQUAL(0, zwave_rx_fixt_teardown());
+}
+
 /// Test of rx init for on_smart_start_event callbacks
 void test_zwave_rx_on_smart_start_event()
 {
