From 2a482e7f493add96847f3675a6e17134c875ab75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=BAben=20Soares=20da=20Silva?= Date: Tue, 23 Apr 2024 22:50:04 +0100 Subject: [PATCH] Move functions for packing/unpacking PARAM.request Add unitary test for PARAM.request ( test pack/unpack, free, copy and compare ) --- nfapi/CMakeLists.txt | 1 + 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/CMakeLists.txt | 3 + nfapi/tests/nr_fapi_test.h | 92 +++++++++++++++++++ nfapi/tests/p5/CMakeLists.txt | 12 +++ nfapi/tests/p5/nr_fapi_param_request_test.c | 86 +++++++++++++++++ 9 files changed, 208 insertions(+), 16 deletions(-) create mode 100644 nfapi/tests/CMakeLists.txt create mode 100644 nfapi/tests/nr_fapi_test.h create mode 100644 nfapi/tests/p5/CMakeLists.txt create mode 100644 nfapi/tests/p5/nr_fapi_param_request_test.c diff --git a/nfapi/CMakeLists.txt b/nfapi/CMakeLists.txt index 1362e33b06..d6c5b0e92a 100644 --- a/nfapi/CMakeLists.txt +++ b/nfapi/CMakeLists.txt @@ -1,2 +1,3 @@ add_subdirectory(oai_integration/aerial) add_subdirectory(open-nFAPI) +add_subdirectory(tests) diff --git a/nfapi/open-nFAPI/fapi/inc/nr_fapi_p5.h b/nfapi/open-nFAPI/fapi/inc/nr_fapi_p5.h index 197f23d06d..983fe15302 100644 --- a/nfapi/open-nFAPI/fapi/inc/nr_fapi_p5.h +++ b/nfapi/open-nFAPI/fapi/inc/nr_fapi_p5.h @@ -34,4 +34,6 @@ #include "stdint.h" #include "nfapi_interface.h" +uint8_t pack_nr_param_request(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config); +uint8_t unpack_nr_param_request(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 4ad26dcfd3..776c6d700e 100644 --- a/nfapi/open-nFAPI/fapi/src/nr_fapi_p5.c +++ b/nfapi/open-nFAPI/fapi/src/nr_fapi_p5.c @@ -325,3 +325,15 @@ int check_nr_fapi_unpack_length(nfapi_nr_phy_msg_type_e msgId, uint32_t unpacked return retLen; } + +uint8_t pack_nr_param_request(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config) +{ + nfapi_nr_param_request_scf_t *pNfapiMsg = (nfapi_nr_param_request_scf_t *)msg; + return (pack_vendor_extension_tlv(pNfapiMsg->vendor_extension, ppWritePackedMsg, end, config)); +} + +uint8_t unpack_nr_param_request(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config) +{ + nfapi_nr_param_request_scf_t *pNfapiMsg = (nfapi_nr_param_request_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 264dffecab..a771d74bee 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_param_request(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config); - -uint8_t unpack_nr_param_request(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config); - uint8_t pack_nr_param_response(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config); uint8_t unpack_nr_param_response(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 4795b35aa9..30996f5abb 100644 --- a/nfapi/open-nFAPI/nfapi/src/nfapi_p5.c +++ b/nfapi/open-nFAPI/nfapi/src/nfapi_p5.c @@ -274,12 +274,6 @@ static uint8_t pack_pnf_stop_response(void *msg, uint8_t **ppWritePackedMsg, uin pack_vendor_extension_tlv(pNfapiMsg->vendor_extension, ppWritePackedMsg, end, config)); } -uint8_t pack_nr_param_request(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config) -{ - nfapi_nr_param_request_scf_t *pNfapiMsg = (nfapi_nr_param_request_scf_t *)msg; - return (pack_vendor_extension_tlv(pNfapiMsg->vendor_extension, ppWritePackedMsg, end, config)); -} - static uint8_t pack_param_request(void *msg, uint8_t **ppWritePackedMsg, uint8_t *end, nfapi_p4_p5_codec_config_t *config) { nfapi_param_request_t *pNfapiMsg = (nfapi_param_request_t *)msg; return (pack_vendor_extension_tlv(pNfapiMsg->vendor_extension, ppWritePackedMsg, end, config)); @@ -2451,12 +2445,6 @@ static uint8_t unpack_param_request(uint8_t **ppReadPackedMsg, uint8_t *end, voi return unpack_tlv_list(NULL, 0, ppReadPackedMsg, end, config, &(pNfapiMsg->vendor_extension)); } -uint8_t unpack_nr_param_request(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config) -{ - nfapi_nr_param_request_scf_t *pNfapiMsg = (nfapi_nr_param_request_scf_t *)msg; - return unpack_nr_tlv_list(NULL, 0, ppReadPackedMsg, end, config, &(pNfapiMsg->vendor_extension)); -} - static uint8_t unpack_param_response(uint8_t **ppReadPackedMsg, uint8_t *end, void *msg, nfapi_p4_p5_codec_config_t *config) { nfapi_param_response_t *pNfapiMsg = (nfapi_param_response_t *)msg; diff --git a/nfapi/tests/CMakeLists.txt b/nfapi/tests/CMakeLists.txt new file mode 100644 index 0000000000..f04f7fe7a2 --- /dev/null +++ b/nfapi/tests/CMakeLists.txt @@ -0,0 +1,3 @@ +if (ENABLE_TESTS) + add_subdirectory(p5) +endif () diff --git a/nfapi/tests/nr_fapi_test.h b/nfapi/tests/nr_fapi_test.h new file mode 100644 index 0000000000..8f30bfb407 --- /dev/null +++ b/nfapi/tests/nr_fapi_test.h @@ -0,0 +1,92 @@ +/* + * 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_test.h + * \brief + * \author Ruben S. Silva + * \date 2024 + * \version 0.1 + * \company OpenAirInterface Software Alliance + * \email: contact@openairinterface.org, rsilva@allbesmart.pt + * \note + * \warning + */ + +#ifndef OPENAIRINTERFACE_NR_FAPI_TEST_H +#define OPENAIRINTERFACE_NR_FAPI_TEST_H +#include +#include +#include +#include +#include +#include + +#ifndef _STANDALONE_TESTING_ +#include "common/utils/LOG/log.h" +#endif +#include "nfapi_nr_interface.h" +#include "nfapi_nr_interface_scf.h" + +uint8_t rand8() +{ + return (rand() & 0xff); +} +uint16_t rand16() +{ + return rand8() << 8 | rand8(); +} +uint32_t rand24() +{ + return rand16() << 8 | rand8(); +} +uint32_t rand32() +{ + return rand24() << 8 | rand8(); +} +uint64_t rand64() +{ + return (uint64_t)rand32() << 32 | rand32(); +} + +uint8_t rand8_range(uint8_t lower, uint8_t upper) +{ + return (rand() % (upper - lower + 1)) + lower; +} + +uint16_t rand16_range(uint16_t lower, uint16_t upper) +{ + return (rand() % (upper - lower + 1)) + lower; +} + +int main(int n, char *v[]); + +static inline void fapi_test_init_seeded(time_t seed) +{ + srand(seed); + printf("srand seed is %ld\n", seed); + logInit(); + set_glog(OAILOG_DISABLE); +} + +static inline void fapi_test_init() +{ + fapi_test_init_seeded(time(NULL)); +} +#endif // OPENAIRINTERFACE_NR_FAPI_TEST_H diff --git a/nfapi/tests/p5/CMakeLists.txt b/nfapi/tests/p5/CMakeLists.txt new file mode 100644 index 0000000000..7544e176a5 --- /dev/null +++ b/nfapi/tests/p5/CMakeLists.txt @@ -0,0 +1,12 @@ +set(Test_Labels fapi p5) +set(_fapi_p5_messages "param_request") + +foreach (fapi_p5_message IN LISTS _fapi_p5_messages) + add_executable(nr_fapi_${fapi_p5_message}_test nr_fapi_${fapi_p5_message}_test.c) + target_link_libraries(nr_fapi_${fapi_p5_message}_test PUBLIC nr_fapi_p5) + target_link_libraries(nr_fapi_${fapi_p5_message}_test PRIVATE pthread UTIL ${T_LIB} minimal_lib) + add_dependencies(tests nr_fapi_${fapi_p5_message}_test) + + add_test(nr_fapi_${fapi_p5_message}_test nr_fapi_${fapi_p5_message}_test) + set_tests_properties(nr_fapi_${fapi_p5_message}_test PROPERTIES LABELS "${Test_Labels}") +endforeach () diff --git a/nfapi/tests/p5/nr_fapi_param_request_test.c b/nfapi/tests/p5/nr_fapi_param_request_test.c new file mode 100644 index 0000000000..5356160ca4 --- /dev/null +++ b/nfapi/tests/p5/nr_fapi_param_request_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_param_request_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_param_request_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); + // PARAM.request 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_param_request_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_param_request(&unpacked_req, req)); + free_param_request(&unpacked_req); +} + +void test_copy(const nfapi_nr_param_request_scf_t *msg) +{ + // Test copy function + nfapi_nr_param_request_scf_t copy = {0}; + copy_param_request(msg, ©); + DevAssert(eq_param_request(msg, ©)); + free_param_request(©); +} + +int main(int n, char *v[]) +{ + fapi_test_init(); + + nfapi_nr_param_request_scf_t req = {.header.message_id = NFAPI_NR_PHY_MSG_TYPE_PARAM_REQUEST}; + // Perform tests + test_pack_unpack(&req); + test_copy(&req); + // All tests successful! + free_param_request(&req); + return 0; +}