fix(zwapi): Add test to check for injection in caps

This change is isolated to revert the previous fix for testing

Test will fail when the fix is reverted as:

    zwapi_init_test.c:250:test_zwapi_refresh_capabilities_bitmask:PASS
    zwapi_init_test.c:302:test_zwapi_refresh_capabilities_bitmask_injection:FAIL:Function zwapi_session_flush_queue.  Called more times than expected.
    2025-Jun-20 16:39:06.270076 <E> [zwapi_init] Failed to fetch capabilities from the Z-Wave module
    zwapi_init_test.c:355:test_zwapi_refresh_capabilities_bad_cases:PASS

Origin: SiliconLabsSoftware#125
Bug-SiliconLabs: UIC-3664
Relate-to: SLVDBBP-3162484
Relate-to: SiliconLabsSoftware/z-wave-engine-application-layer#42
Signed-off-by: Philippe Coval <[email protected]>

Author: rzr

applications/zpc/components/zwave_api/test/zwapi_init_test.c

@@ -22,11 +22,25 @@
 #include "zwapi_func_ids.h"
 #include "zwapi_session_mock.h"
 #include "zwapi_protocol_basis_mock.h"
+#include "zwapi_internal.h"
 
 // Static variables
 static uint8_t response_length      = 0;
 static uint8_t response_buffer[255] = {0};
 
+// Unmocked stubs functions:
+
+uint8_t* zwapi_get_zw_library_version_stub(uint8_t* dst, int cmock_num_calls)
+{
+    return 0; //defaut, not valid
+}
+
+zwave_rf_region_t zwapi_get_rf_region_stub(int cmock_num_calls)
+{
+    return 0; // default
+}
+
+
 /// Setup the test suite (called once before all test_xxx functions are called)
 void suiteSetUp() {}
 
@@ -233,6 +247,111 @@ void test_zwapi_init()
   TEST_ASSERT_EQUAL(3, serial_fd);
 }
 
+void test_zwapi_refresh_capabilities_bitmask(void)
+{
+    zwapi_chip_data_t chip;
+    uint8_t response_buffer[FRAME_LENGTH_MAX] = {0};
+    uint8_t response_length = IDX_DATA + 7 + sizeof(chip.supported_bitmask); 
+    memset(response_buffer, 0xAA, sizeof(response_buffer)); // Fill with dummy data
+
+    // Simulate a valid response with sufficient length for supported_bitmask
+    zwapi_session_send_frame_with_response_ExpectAndReturn(
+      FUNC_ID_SERIAL_API_GET_CAPABILITIES,
+      NULL,
+      0,
+      NULL,
+      NULL,
+      SL_STATUS_OK);
+    zwapi_session_send_frame_with_response_IgnoreArg_response_buf();
+    zwapi_session_send_frame_with_response_IgnoreArg_response_len();
+    zwapi_session_send_frame_with_response_ReturnMemThruPtr_response_buf(
+      response_buffer,
+      response_length);
+    zwapi_session_send_frame_with_response_ReturnThruPtr_response_len(
+      &response_length);
+    
+    zwapi_get_zw_library_version_Stub(zwapi_get_zw_library_version_stub);
+
+    zwapi_session_flush_queue_Expect();
+
+    {
+        uint8_t response_buffer[FRAME_LENGTH_MAX] = {0};
+        uint8_t response_length = IDX_DATA + 1;
+        
+        zwapi_session_send_frame_with_response_ExpectAndReturn(FUNC_ID_SERIAL_API_GET_INIT_DATA,
+                                                               NULL,
+                                                               0,
+                                                               NULL,
+                                                               NULL,
+                                                               SL_STATUS_OK);
+        zwapi_session_send_frame_with_response_IgnoreArg_response_buf();
+        zwapi_session_send_frame_with_response_IgnoreArg_response_len();
+        zwapi_session_send_frame_with_response_ReturnMemThruPtr_response_buf(
+            response_buffer,
+            response_length);
+        zwapi_session_send_frame_with_response_ReturnThruPtr_response_len(
+            &response_length);
+    }
+
+    zwapi_get_rf_region_Stub(zwapi_get_rf_region_stub);
+    //TEST_ASSERT_EQUAL(SL_STATUS_OK, zwapi_session_flush_queue());
+    TEST_ASSERT_EQUAL(SL_STATUS_OK, zwapi_refresh_capabilities());
+    // TEST_ASSERT_EQUAL_UINT8_ARRAY(response_buffer + IDX_DATA + 7, chip.supported_bitmask, sizeof(chip.supported_bitmask));
+}
+
+void test_zwapi_refresh_capabilities_bitmask_injection(void)
+{
+    zwapi_chip_data_t chip;
+    uint8_t response_buffer[FRAME_LENGTH_MAX] = {0};
+    uint8_t response_length = FRAME_LENGTH_MAX;
+    memset(response_buffer, 0xAA, sizeof(response_buffer)); // Fill with dummy data
+
+    // Simulate a valid response with sufficient length for supported_bitmask
+    zwapi_session_send_frame_with_response_ExpectAndReturn(
+      FUNC_ID_SERIAL_API_GET_CAPABILITIES,
+      NULL,
+      0,
+      NULL,
+      NULL,
+      SL_STATUS_OK);
+    zwapi_session_send_frame_with_response_IgnoreArg_response_buf();
+    zwapi_session_send_frame_with_response_IgnoreArg_response_len();
+    zwapi_session_send_frame_with_response_ReturnMemThruPtr_response_buf(
+      response_buffer,
+      response_length);
+    zwapi_session_send_frame_with_response_ReturnThruPtr_response_len(
+      &response_length);
+    
+    zwapi_get_zw_library_version_Stub(zwapi_get_zw_library_version_stub);
+    if (false) {
+    zwapi_session_flush_queue_Expect();
+    // TEST_ASSERT_EQUAL(SL_STATUS_OK, zwapi_session_flush_queue());
+
+        uint8_t response_buffer[FRAME_LENGTH_MAX] = {0};
+        uint8_t response_length = IDX_DATA + 1;
+        
+        zwapi_session_send_frame_with_response_ExpectAndReturn(FUNC_ID_SERIAL_API_GET_INIT_DATA,
+                                                               NULL,
+                                                               0,
+                                                               NULL,
+                                                               NULL,
+                                                               SL_STATUS_OK);
+        zwapi_session_send_frame_with_response_IgnoreArg_response_buf();
+        zwapi_session_send_frame_with_response_IgnoreArg_response_len();
+        zwapi_session_send_frame_with_response_ReturnMemThruPtr_response_buf(
+            response_buffer,
+            response_length);
+        zwapi_session_send_frame_with_response_ReturnThruPtr_response_len(
+            &response_length);
+    }
+
+    zwapi_get_rf_region_Stub(zwapi_get_rf_region_stub);
+    //
+    TEST_ASSERT_EQUAL(SL_STATUS_FAIL, zwapi_refresh_capabilities());
+    // TEST_ASSERT_EQUAL_UINT8_ARRAY(response_buffer + IDX_DATA + 7, chip.supported_bitmask, sizeof(chip.supported_bitmask));
+}
+
+
 void test_zwapi_refresh_capabilities_bad_cases()
 {
   //Capablities status fail
@@ -360,4 +479,5 @@ void test_zwapi_log_to_file_enable(void)
 void test_zwapi_log_to_file_disable(void)
 {
   TEST_ASSERT_EQUAL(SL_STATUS_OK, zwapi_log_to_file_disable());
+
 }