/** * @file * @author Steve Karg * @date April 2020 * @brief Test file for a basic BBMD for BVLC IPv4 handler * * @section LICENSE * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #include /* for standard i/o, like printing */ #include /* for standard integer types uint8_t etc. */ #include /* for the standard bool type. */ #include /* for memcpy */ #include #include #include "bacnet/bacdcode.h" #include "bacnet/iam.h" #include "bacnet/npdu.h" #include "bacnet/datalink/bip.h" #include "bacnet/datalink/bvlc.h" #include "bacnet/basic/sys/debug.h" #include "bacnet/basic/object/device.h" #include "bacnet/basic/bbmd/h_bbmd.h" #include "ctest.h" struct device_info_t { uint32_t Device_ID; BACNET_IP_ADDRESS BIP_Addr; BACNET_IP_ADDRESS BIP_Broadcast_Addr; BACNET_ADDRESS BACnet_Address; }; static struct device_info_t TD; static struct device_info_t IUT; /* for the reply sent from the handler */ static uint8_t Test_Sent_Message_Type; static uint8_t Test_Sent_Message_Length; static uint8_t Test_Sent_Message_Buffer[MAX_MPDU]; static uint16_t Test_Sent_Message_Buffer_Length; static BACNET_IP_ADDRESS Test_Sent_Message_Dest; /* network stub functions */ /** * BACnet/IP Datalink Receive handler. * * @param src - returns the source address * @param npdu - returns the NPDU buffer * @param max_npdu -maximum size of the NPDU buffer * @param timeout - number of milliseconds to wait for a packet * * @return Number of bytes received, or 0 if none or timeout. */ uint16_t bip_receive( BACNET_ADDRESS *src, uint8_t *npdu, uint16_t max_npdu, unsigned timeout) { return 0; } /** * The send function for BACnet/IPv6 driver layer * * @param dest - Points to a BACNET_IP_ADDRESS structure containing the * destination address. * @param mtu - the bytes of data to send * @param mtu_len - the number of bytes of data to send * * @return Upon successful completion, returns the number of bytes sent. * Otherwise, -1 shall be returned and errno set to indicate the error. */ int bip_send_mpdu(BACNET_IP_ADDRESS *dest, uint8_t *mtu, uint16_t mtu_len) { uint8_t message_type = 0; uint16_t message_length = 0; int header_len = 0; header_len = bvlc_decode_header(mtu, mtu_len, &message_type, &message_length); Test_Sent_Message_Type = message_type; Test_Sent_Message_Length = message_length; bvlc_address_copy(&Test_Sent_Message_Dest, dest); if ((header_len == 4) && (mtu_len >= 4)) { memcpy(&Test_Sent_Message_Buffer[0], &mtu[4], mtu_len - 4); Test_Sent_Message_Buffer_Length = mtu_len - 4; } else { Test_Sent_Message_Buffer_Length = 0; } return 0; } /** Return the Object Instance number for our (single) Device Object. * This is a key function, widely invoked by the handler code, since * it provides "our" (ie, local) address. * * @return The Instance number used in the BACNET_OBJECT_ID for the Device. */ uint32_t Device_Object_Instance_Number(void) { return IUT.Device_ID; } /** * Get the BACnet/IP address * * @return BACnet/IP address */ bool bip_get_addr(BACNET_IP_ADDRESS *addr) { return bvlc_address_copy(addr, &IUT.BIP_Addr); } /** * Get the BACnet/IP address * * @return BACnet/IP address */ bool bip_get_broadcast_addr(BACNET_IP_ADDRESS *addr) { return bvlc_address_copy(addr, &IUT.BIP_Broadcast_Addr); } static void test_setup(void) { bvlc_init(); bvlc_address_set(&TD.BIP_Broadcast_Addr, 255, 255, 255, 255); bvlc_address_set(&TD.BIP_Addr, 192, 168, 1, 100); TD.Device_ID = 12345; bvlc_address_set(&IUT.BIP_Broadcast_Addr, 255, 255, 255, 255); bvlc_address_set(&IUT.BIP_Addr, 192, 168, 1, 10); IUT.Device_ID = 54321; } static void test_cleanup(void) { } /** * @brief Test 15.2.1.1 Initiate Original-Broadcast-NPDU */ static void test_Initiate_Original_Broadcast_NPDU(Test *pTest) { uint8_t pdu[MAX_MPDU] = { 0 }; int npdu_len = 0; int apdu_len = 0; int pdu_len = 0; BACNET_ADDRESS dest = { 0 }; BACNET_NPDU_DATA npdu_data = { 0 }; uint8_t test_pdu[MAX_MPDU] = { 0 }; uint16_t test_pdu_len = 0; int function_len = 0; test_setup(); /* MAKE(the IUT send a broadcast) */ dest.net = BACNET_BROADCAST_NETWORK; npdu_encode_npdu_data(&npdu_data, false, MESSAGE_PRIORITY_NORMAL); npdu_len = npdu_encode_pdu(&pdu[0], &dest, &IUT.BACnet_Address, &npdu_data); apdu_len = iam_encode_apdu( &pdu[npdu_len], IUT.Device_ID, MAX_APDU, SEGMENTATION_NONE, BACNET_VENDOR_ID); pdu_len = npdu_len + apdu_len; bvlc_send_pdu(&dest, &npdu_data, pdu, pdu_len); /* DA=Link Local Multicast Address */ ct_test( pTest, !bvlc_address_different( &TD.BIP_Broadcast_Addr, &Test_Sent_Message_Dest)); /* SA = IUT - done in port layer */ /* Original-Broadcast-NPDU */ ct_test(pTest, Test_Sent_Message_Type == BVLC_ORIGINAL_BROADCAST_NPDU); if (Test_Sent_Message_Type == BVLC_ORIGINAL_BROADCAST_NPDU) { function_len = bvlc_decode_original_broadcast( Test_Sent_Message_Buffer, Test_Sent_Message_Buffer_Length, test_pdu, sizeof(test_pdu), &test_pdu_len); printf( "len=%u pdu[%u] test_pdu[%u]\n", (unsigned)function_len, (unsigned)Test_Sent_Message_Buffer_Length, (unsigned)sizeof(test_pdu)); ct_test(pTest, function_len > 0); /* (any valid BACnet-Unconfirmed-Request-PDU, with any valid broadcast network options */ ct_test(pTest, test_pdu_len == pdu_len); } test_cleanup(); } static void test_BBMD_Result(Test *pTest) { int result = 0; uint16_t result_code[] = { BVLC_RESULT_SUCCESSFUL_COMPLETION, BVLC_RESULT_WRITE_BROADCAST_DISTRIBUTION_TABLE_NAK, BVLC_RESULT_READ_BROADCAST_DISTRIBUTION_TABLE_NAK, BVLC_RESULT_REGISTER_FOREIGN_DEVICE_NAK, BVLC_RESULT_READ_FOREIGN_DEVICE_TABLE_NAK, BVLC_RESULT_DELETE_FOREIGN_DEVICE_TABLE_ENTRY_NAK, BVLC_RESULT_DISTRIBUTE_BROADCAST_TO_NETWORK_NAK }; size_t result_code_max = sizeof(result_code) / sizeof(result_code[0]); uint16_t test_result_code = 0; uint8_t test_function_code = 0; BACNET_IP_ADDRESS addr; BACNET_ADDRESS src; unsigned int i = 0; uint8_t mtu[MAX_MPDU] = { 0 }; uint16_t mtu_len = 0; bvlc_address_port_from_ascii(&addr, "192.168.0.1", "0xBAC0"); for (i = 0; i < result_code_max; i++) { mtu_len = bvlc_encode_result(&mtu[0], sizeof(mtu), result_code[i]); result = bvlc_bbmd_disabled_handler(&addr, &src, &mtu[0], mtu_len); /* validate that the result is handled (0) */ ct_test(pTest, result == 0); test_result_code = bvlc_get_last_result(); ct_test(pTest, test_result_code == result_code[i]); test_function_code = bvlc_get_function_code(); ct_test(pTest, test_function_code == BVLC_RESULT); result = bvlc_bbmd_enabled_handler(&addr, &src, &mtu[0], mtu_len); /* validate that the result is handled (0) */ ct_test(pTest, result == 0); test_result_code = bvlc_get_last_result(); ct_test(pTest, test_result_code == result_code[i]); test_function_code = bvlc_get_function_code(); ct_test(pTest, test_function_code == BVLC_RESULT); } } static void test_BBMD_Handler(Test *pTest) { bool rc; /* individual tests */ rc = ct_addTestFunction(pTest, test_BBMD_Result); assert(rc); rc = ct_addTestFunction(pTest, test_Initiate_Original_Broadcast_NPDU); assert(rc); } int main(void) { Test *pTest; pTest = ct_create("BACnet Broadcast Management Device IP/v4", NULL); test_BBMD_Handler(pTest); /* configure output */ ct_setStream(pTest, stdout); ct_run(pTest); (void)ct_report(pTest); ct_destroy(pTest); return 0; }