From 1d6dc56797f8b867cbf283f205f7d5f823b53340 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=BAben=20Soares=20da=20Silva?= <rsilva@allbesmart.pt>
Date: Wed, 24 Apr 2024 12:35:43 +0100
Subject: [PATCH] Move functions for packing/unpacking STOP.indication
Add unitary test for STOP.indication ( test pack/unpack, free, copy and compare )
---
nfapi/open-nFAPI/fapi/inc/nr_fapi_p5.h | 2 +
nfapi/open-nFAPI/fapi/src/nr_fapi_p5.c | 12 +++
.../nfapi/public_inc/nfapi_interface.h | 4 -
nfapi/open-nFAPI/nfapi/src/nfapi_p5.c | 12 ---
nfapi/tests/p5/CMakeLists.txt | 2 +-
nfapi/tests/p5/nr_fapi_stop_indication_test.c | 86 +++++++++++++++++++
6 files changed, 101 insertions(+), 17 deletions(-)
create mode 100644 nfapi/tests/p5/nr_fapi_stop_indication_test.c
diff --git a/nfapi/open-nFAPI/fapi/inc/nr_fapi_p5.h b/nfapi/open-nFAPI/fapi/inc/nr_fapi_p5.h
index ebe735c3709..6a2cf08c6fd 100644
--- a/nfapi/open-nFAPI/fapi/inc/nr_fapi_p5.h
+++ b/nfapi/open-nFAPI/fapi/inc/nr_fapi_p5.h
@@ -48,4 +48,6 @@ uint8_t pack_nr_start_response(void *msg, uint8_t **ppWritePackedMsg, uint8_t *e
uint8_t unpack_nr_start_response(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config);
uint8_t pack_nr_stop_request(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config);
uint8_t unpack_nr_stop_request(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config);
+uint8_t pack_nr_stop_indication(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config);
+uint8_t unpack_nr_stop_indication(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config);
#endif // OPENAIRINTERFACE_NR_FAPI_P5_H
diff --git a/nfapi/open-nFAPI/fapi/src/nr_fapi_p5.c b/nfapi/open-nFAPI/fapi/src/nr_fapi_p5.c
index 3d0b81e745e..0e90253cfa4 100644
--- a/nfapi/open-nFAPI/fapi/src/nr_fapi_p5.c
+++ b/nfapi/open-nFAPI/fapi/src/nr_fapi_p5.c
@@ -1670,3 +1670,15 @@ uint8_t unpack_nr_stop_request(uint8_t **ppReadPackedMsg, uint8_t *end, void *ms
nfapi_nr_stop_request_scf_t *pNfapiMsg = (nfapi_nr_stop_request_scf_t *)msg;
return unpack_nr_tlv_list(NULL, 0, ppReadPackedMsg, end, config, &(pNfapiMsg->vendor_extension));
}
+
+uint8_t pack_nr_stop_indication(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config)
+{
+ nfapi_nr_stop_indication_scf_t *pNfapiMsg = (nfapi_nr_stop_indication_scf_t *)msg;
+ return pack_vendor_extension_tlv(pNfapiMsg->vendor_extension, ppWritePackedMsg, end, config);
+}
+
+uint8_t unpack_nr_stop_indication(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config)
+{
+ nfapi_nr_stop_indication_scf_t *pNfapiMsg = (nfapi_nr_stop_indication_scf_t *)msg;
+ return unpack_nr_tlv_list(NULL, 0, ppReadPackedMsg, end, config, &(pNfapiMsg->vendor_extension));
+}
diff --git a/nfapi/open-nFAPI/nfapi/public_inc/nfapi_interface.h b/nfapi/open-nFAPI/nfapi/public_inc/nfapi_interface.h
index 30b30bdba09..15b4d4e9804 100644
--- a/nfapi/open-nFAPI/nfapi/public_inc/nfapi_interface.h
+++ b/nfapi/open-nFAPI/nfapi/public_inc/nfapi_interface.h
@@ -4121,10 +4121,6 @@ int pack_nr_srs_beamforming_report(void *pMessageBuf, void *pPackedBuf, uint32_t
*/
int unpack_nr_srs_beamforming_report(void *pMessageBuf, uint32_t messageBufLen, void *pUnpackedBuf, uint32_t unpackedBufLen);
-uint8_t pack_nr_stop_indication(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config);
-
-uint8_t unpack_nr_stop_indication(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config);
-
uint8_t pack_nr_error_indication(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config);
uint8_t unpack_nr_error_indication(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config);
diff --git a/nfapi/open-nFAPI/nfapi/src/nfapi_p5.c b/nfapi/open-nFAPI/nfapi/src/nfapi_p5.c
index 90025a398d7..3d0d796378f 100644
--- a/nfapi/open-nFAPI/nfapi/src/nfapi_p5.c
+++ b/nfapi/open-nFAPI/nfapi/src/nfapi_p5.c
@@ -1169,12 +1169,6 @@ static uint8_t pack_stop_request(void *msg, uint8_t **ppWritePackedMsg, uint8_t
return pack_vendor_extension_tlv(pNfapiMsg->vendor_extension, ppWritePackedMsg, end, config);
}
-uint8_t pack_nr_stop_indication(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config)
-{
- nfapi_nr_stop_indication_scf_t *pNfapiMsg = (nfapi_nr_stop_indication_scf_t *)msg;
- return pack_vendor_extension_tlv(pNfapiMsg->vendor_extension, ppWritePackedMsg, end, config);
-}
-
uint8_t pack_nr_error_indication(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config)
{
nfapi_nr_error_indication_scf_t *pNfapiMsg = (nfapi_nr_error_indication_scf_t *)msg;
@@ -2099,12 +2093,6 @@ static uint8_t unpack_stop_request(uint8_t **ppReadPackedMsg, uint8_t *end, void
return unpack_tlv_list(NULL, 0, ppReadPackedMsg, end, config, &(pNfapiMsg->vendor_extension));
}
-uint8_t unpack_nr_stop_indication(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config)
-{
- nfapi_nr_stop_indication_scf_t *pNfapiMsg = (nfapi_nr_stop_indication_scf_t *)msg;
- return unpack_nr_tlv_list(NULL, 0, ppReadPackedMsg, end, config, &(pNfapiMsg->vendor_extension));
-}
-
uint8_t unpack_nr_error_indication(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config)
{
nfapi_nr_error_indication_scf_t *pNfapiMsg = (nfapi_nr_error_indication_scf_t *)msg;
diff --git a/nfapi/tests/p5/CMakeLists.txt b/nfapi/tests/p5/CMakeLists.txt
index e62104c29f7..2fb323f6c29 100644
--- a/nfapi/tests/p5/CMakeLists.txt
+++ b/nfapi/tests/p5/CMakeLists.txt
@@ -1,5 +1,5 @@
set(Test_Labels fapi p5)
-set(_fapi_p5_messages "param_request;param_response;config_request;config_response;start_request;start_response;stop_request")
+set(_fapi_p5_messages "param_request;param_response;config_request;config_response;start_request;start_response;stop_request;stop_indication")
foreach (fapi_p5_message IN LISTS _fapi_p5_messages)
add_executable(nr_fapi_${fapi_p5_message}_test nr_fapi_${fapi_p5_message}_test.c)
diff --git a/nfapi/tests/p5/nr_fapi_stop_indication_test.c b/nfapi/tests/p5/nr_fapi_stop_indication_test.c
new file mode 100644
index 00000000000..ee3946c8e40
--- /dev/null
+++ b/nfapi/tests/p5/nr_fapi_stop_indication_test.c
@@ -0,0 +1,86 @@
+/*
+ * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The OpenAirInterface Software Alliance licenses this file to You under
+ * the OAI Public License, Version 1.1 (the "License"); you may not use this file
+ * except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.openairinterface.org/?page_id=698
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *-------------------------------------------------------------------------------
+ * For more information about the OpenAirInterface (OAI) Software Alliance:
+ * contact@openairinterface.org
+ */
+/*! \file nfapi/tests/p5/nr_fapi_stop_indication_test.c
+ * \brief
+ * \author Ruben S. Silva
+ * \date 2024
+ * \version 0.1
+ * \company OpenAirInterface Software Alliance
+ * \email: contact@openairinterface.org, rsilva@allbesmart.pt
+ * \note
+ * \warning
+ */
+#include "nfapi/tests/nr_fapi_test.h"
+#include "nr_fapi_p5_utils.h"
+
+void test_pack_unpack(nfapi_nr_stop_indication_scf_t *req)
+{
+ uint8_t msg_buf[65535];
+ uint16_t msg_len = sizeof(*req);
+ // first test the packing procedure
+ int pack_result = fapi_nr_p5_message_pack(req, msg_len, msg_buf, sizeof(msg_buf), NULL);
+ // STOP.indication message body length is 0
+ DevAssert(pack_result == 0 + NFAPI_HEADER_LENGTH);
+ // update req message_length value with value calculated in message_pack procedure
+ req->header.message_length = pack_result - NFAPI_HEADER_LENGTH;
+ // test the unpacking of the header
+ // copy first NFAPI_HEADER_LENGTH bytes into a new buffer, to simulate SCTP PEEK
+ fapi_message_header_t header;
+ uint32_t header_buffer_size = NFAPI_HEADER_LENGTH;
+ uint8_t header_buffer[header_buffer_size];
+ for (int idx = 0; idx < header_buffer_size; idx++) {
+ header_buffer[idx] = msg_buf[idx];
+ }
+ uint8_t *pReadPackedMessage = header_buffer;
+ int unpack_header_result = fapi_nr_p5_message_header_unpack(&pReadPackedMessage, NFAPI_HEADER_LENGTH, &header, sizeof(header), 0);
+ DevAssert(unpack_header_result >= 0);
+ DevAssert(header.message_id == req->header.message_id);
+ DevAssert(header.message_length == req->header.message_length);
+ // test the unpacking and compare with initial message
+ nfapi_nr_stop_indication_scf_t unpacked_req = {0};
+ int unpack_result =
+ fapi_nr_p5_message_unpack(msg_buf, header.message_length + NFAPI_HEADER_LENGTH, &unpacked_req, sizeof(unpacked_req), NULL);
+ DevAssert(unpack_result >= 0);
+ DevAssert(eq_stop_indication(&unpacked_req, req));
+ free_stop_indication(&unpacked_req);
+}
+
+void test_copy(const nfapi_nr_stop_indication_scf_t *msg)
+{
+ // Test copy function
+ nfapi_nr_stop_indication_scf_t copy = {0};
+ copy_stop_indication(msg, ©);
+ DevAssert(eq_stop_indication(msg, ©));
+ free_stop_indication(©);
+}
+
+int main(int n, char *v[])
+{
+ fapi_test_init();
+
+ nfapi_nr_stop_indication_scf_t req = {.header.message_id = NFAPI_NR_PHY_MSG_TYPE_STOP_INDICATION};
+ // Perform tests
+ test_pack_unpack(&req);
+ test_copy(&req);
+ // All tests successful!
+ free_stop_indication(&req);
+ return 0;
+}
--
GitLab