uic: zpc: Pull request #2921: UIC-3595: Add unit test to zwave_tx module for protocol frame

Merge in UIC/uic from feature/UIC-3595-add-zwave_tx-unit-test to develop

(cherry picked from commit 5eea13e0e5c7ab41e72493fd06844d0653221c05)
Forwarded: #11
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>

Author: silabs-aydogane

applications/zpc/components/zwave/zwave_tx/test/zwave_tx_test.c

@@ -258,6 +258,66 @@ void test_zwave_tx_send_data_happy_case()
   TEST_ASSERT_EQUAL_PTR(NULL, received_user_pointer);
 }
 
+void test_zwave_tx_send_protocol_data_happy_case()
+{
+  protocol_metadata_t protocol_metadata = {
+    .tx_session_id = NULL,
+    .session_id    = 1,
+    .data_length   = 7,
+    .data          = {0xDE, 0xAD, 0xBE, 0xEF, 0xCA, 0xFE, 0xBA},
+  };
+
+  zwave_controller_transport_send_data_ExpectWithArrayAndReturn(
+    &test_connection_4,
+    sizeof(test_connection_4),
+    sizeof(test_expected_frame_data_1),
+    test_expected_frame_data_1,
+    sizeof(test_expected_frame_data_1),
+    &test_tx_options_protocol_frame,
+    sizeof(test_tx_options_protocol_frame),
+    NULL,
+    (void *)&protocol_metadata,
+    sizeof(void *),
+    NULL,
+    SL_STATUS_OK);
+
+  zwave_controller_transport_send_data_IgnoreArg_session();
+  zwave_controller_transport_send_data_IgnoreArg_on_send_complete();
+
+  TEST_ASSERT_EQUAL(SL_STATUS_OK,
+                    zwave_tx_send_data(&test_connection_4,
+                                       sizeof(test_expected_frame_data_1),
+                                       test_expected_frame_data_1,
+                                       &test_tx_options_protocol_frame,
+                                       send_data_callback,
+                                       (void *)&protocol_metadata,
+                                       &test_tx_session_id));
+
+  // We are now waiting for more frames, or a transport callback.
+  contiki_test_helper_run_once(DEFAULT_CONTIKI_CLOCK_JUMP);
+
+  // Transport informs it is done.
+  TEST_ASSERT_NOT_NULL(zwave_transport_send_data_save);
+  zwave_transport_send_data_save(TRANSMIT_COMPLETE_VERIFIED,
+                                 &test_tx_report,
+                                 (void *)&protocol_metadata);
+
+  // Now the child frame is fully done.
+  contiki_test_helper_run_clock_increases_for_each_event(
+    TX_BACKOFF_CONTIKI_CLOCK_JUMP);
+
+  // Verify that it looks looks as expected
+  TEST_ASSERT_EQUAL(1, send_done_count);
+  TEST_ASSERT_EQUAL(TRANSMIT_COMPLETE_VERIFIED, send_done_status);
+  // We expect that the transmission time is copied from TX
+  // Contiki made a clock jump of DEFAULT_CONTIKI_CLOCK_JUMP for each event
+  send_done_tx_status.transmit_ticks = 0;
+  TEST_ASSERT_EQUAL_MEMORY(&test_tx_report,
+                           &send_done_tx_status,
+                           sizeof(zwapi_tx_report_t));
+  TEST_ASSERT_EQUAL_PTR((void *)&protocol_metadata, received_user_pointer);
+}
+
 void test_zwave_tx_send_data_fast_track()
 {
   zwave_controller_transport_send_data_ExpectWithArrayAndReturn(

applications/zpc/components/zwave/zwave_tx/test/zwave_tx_test.h

@@ -54,6 +54,12 @@ static const zwave_controller_connection_info_t test_connection_3 = {
   .encapsulation = ZWAVE_CONTROLLER_ENCAPSULATION_NONE,
 };
 
+static const zwave_controller_connection_info_t test_connection_4 = {
+  .local         = {.node_id = 10, .endpoint_id = 10, .is_multicast = false},
+  .remote        = {.node_id = 5, .endpoint_id = 0, .is_multicast = false},
+  .encapsulation = ZWAVE_CONTROLLER_ENCAPSULATION_NONE,
+};
+
 static const zwave_tx_options_t test_tx_options_1
   = {.number_of_responses = 0,
      .discard_timeout_ms  = 0,
@@ -124,6 +130,21 @@ static const zwave_tx_options_t test_tx_options_test_frame
                  .group_id                        = ZWAVE_TX_INVALID_GROUP,
      }};
 
+static const zwave_tx_options_t test_tx_options_protocol_frame
+  = {.number_of_responses = 1,
+     .discard_timeout_ms  = 5000,
+     .qos_priority        = ZWAVE_TX_QOS_MAX_PRIORITY,
+     .fasttrack           = false,
+     .send_follow_ups     = false,
+     .transport           = {
+                 .is_first_follow_up              = false,
+                 .is_test_frame                   = false,
+                 .is_protocol_frame               = true,
+                 .ignore_incoming_frames_back_off = false,
+                 .rf_power                        = MINUS_3_DBM,
+                 .group_id                        = ZWAVE_TX_INVALID_GROUP,
+     }};
+
 static const zwave_tx_options_t test_tx_options_group_id
   = {.number_of_responses = 1,
      .discard_timeout_ms  = 0,