Bugfix/secure alarm ack codec (#647)

* Secured BACnetAcknowledgeAlarmInfo codec and improved unit testing code coverage.
This commit is contained in:
Steve Karg
2024-05-20 11:18:07 -05:00
committed by GitHub
parent ae3930920f
commit cf00e9e094
4 changed files with 253 additions and 259 deletions
+78 -71
View File
@@ -1,13 +1,11 @@
/*
* Copyright (c) 2020 Legrand North America, LLC.
*
* SPDX-License-Identifier: MIT
/**
* @file
* @brief unit test for BACnetAcknowledgeAlarmInfo encoding and decoding
* @author Steve Karg <skarg@users.sourceforge.net>
* @author Greg Shue <greg.shue@outlook.com>
* @date 2009
* @copyright SPDX-License-Identifier: MIT
*/
/* @file
* @brief test BACnet integer encode/decode APIs
*/
#include <zephyr/ztest.h>
#include <bacnet/alarm_ack.h>
@@ -25,92 +23,101 @@ ZTEST(alarm_ack_tests, testAlarmAck)
static void testAlarmAck(void)
#endif
{
BACNET_ALARM_ACK_DATA testAlarmAckIn;
BACNET_ALARM_ACK_DATA testAlarmAckOut;
BACNET_ALARM_ACK_DATA data;
BACNET_ALARM_ACK_DATA test_data;
uint8_t buffer[MAX_APDU];
int inLen;
int outLen;
uint8_t apdu[MAX_APDU];
int null_len, test_len, apdu_len;
bool status;
testAlarmAckIn.ackProcessIdentifier = 0x1234;
characterstring_init_ansi(&testAlarmAckIn.ackSource, "This is a test");
status = bacapp_timestamp_init_ascii(&testAlarmAckIn.ackTimeStamp, "1234");
data.ackProcessIdentifier = 0x1234;
characterstring_init_ansi(&data.ackSource, "This is a test");
status = bacapp_timestamp_init_ascii(&data.ackTimeStamp, "1234");
zassert_true(status, NULL);
zassert_equal(testAlarmAckIn.ackTimeStamp.tag, TIME_STAMP_SEQUENCE, NULL);
zassert_equal(testAlarmAckIn.ackTimeStamp.value.sequenceNum, 1234, NULL);
zassert_equal(data.ackTimeStamp.tag, TIME_STAMP_SEQUENCE, NULL);
zassert_equal(data.ackTimeStamp.value.sequenceNum, 1234, NULL);
testAlarmAckIn.eventObjectIdentifier.instance = 567;
testAlarmAckIn.eventObjectIdentifier.type = OBJECT_DEVICE;
status = bacapp_timestamp_init_ascii(
&testAlarmAckIn.eventTimeStamp, "10:11:12.14");
data.eventObjectIdentifier.instance = 567;
data.eventObjectIdentifier.type = OBJECT_DEVICE;
status = bacapp_timestamp_init_ascii(&data.eventTimeStamp, "10:11:12.14");
zassert_true(status, NULL);
zassert_equal(testAlarmAckIn.eventTimeStamp.tag, TIME_STAMP_TIME, NULL);
testAlarmAckIn.eventStateAcked = EVENT_STATE_OFFNORMAL;
memset(&testAlarmAckOut, 0, sizeof(testAlarmAckOut));
zassert_equal(data.eventTimeStamp.tag, TIME_STAMP_TIME, NULL);
data.eventStateAcked = EVENT_STATE_OFFNORMAL;
memset(&test_data, 0, sizeof(test_data));
inLen = alarm_ack_encode_service_request(buffer, &testAlarmAckIn);
outLen = alarm_ack_decode_service_request(buffer, inLen, &testAlarmAckOut);
zassert_equal(inLen, outLen, "inlen=%d outlen=%d", inLen, outLen);
apdu_len = bacnet_acknowledge_alarm_info_request_encode(apdu, sizeof(apdu), &data);
null_len = bacnet_acknowledge_alarm_info_request_encode(NULL, apdu_len, &data);
zassert_equal(null_len, apdu_len, NULL);
test_len = alarm_ack_decode_service_request(apdu, apdu_len, &test_data);
zassert_equal(
testAlarmAckIn.ackProcessIdentifier,
testAlarmAckOut.ackProcessIdentifier, NULL);
apdu_len, test_len, "apdu_len=%d test_len=%d", apdu_len, test_len);
zassert_equal(
testAlarmAckIn.ackTimeStamp.tag, testAlarmAckOut.ackTimeStamp.tag,
"in-tag=%d out-tag=%d", testAlarmAckIn.ackTimeStamp.tag,
testAlarmAckOut.ackTimeStamp.tag);
zassert_equal(
testAlarmAckIn.ackTimeStamp.value.sequenceNum,
testAlarmAckOut.ackTimeStamp.value.sequenceNum, NULL);
data.ackProcessIdentifier, test_data.ackProcessIdentifier, NULL);
zassert_equal(
testAlarmAckIn.ackProcessIdentifier,
testAlarmAckOut.ackProcessIdentifier, NULL);
data.ackTimeStamp.tag, test_data.ackTimeStamp.tag,
"in-tag=%d out-tag=%d", data.ackTimeStamp.tag,
test_data.ackTimeStamp.tag);
zassert_equal(
data.ackTimeStamp.value.sequenceNum,
test_data.ackTimeStamp.value.sequenceNum, NULL);
zassert_equal(
testAlarmAckIn.eventObjectIdentifier.instance,
testAlarmAckOut.eventObjectIdentifier.instance, NULL);
zassert_equal(
testAlarmAckIn.eventObjectIdentifier.type,
testAlarmAckOut.eventObjectIdentifier.type, NULL);
data.ackProcessIdentifier, test_data.ackProcessIdentifier, NULL);
zassert_equal(
testAlarmAckIn.eventTimeStamp.tag, testAlarmAckOut.eventTimeStamp.tag,
data.eventObjectIdentifier.instance,
test_data.eventObjectIdentifier.instance, NULL);
zassert_equal(
data.eventObjectIdentifier.type, test_data.eventObjectIdentifier.type,
NULL);
zassert_equal(
testAlarmAckIn.eventTimeStamp.value.time.hour,
testAlarmAckOut.eventTimeStamp.value.time.hour, NULL);
zassert_equal(
testAlarmAckIn.eventTimeStamp.value.time.min,
testAlarmAckOut.eventTimeStamp.value.time.min, NULL);
zassert_equal(
testAlarmAckIn.eventTimeStamp.value.time.sec,
testAlarmAckOut.eventTimeStamp.value.time.sec, NULL);
zassert_equal(
testAlarmAckIn.eventTimeStamp.value.time.hundredths,
testAlarmAckOut.eventTimeStamp.value.time.hundredths, NULL);
zassert_equal(data.eventTimeStamp.tag, test_data.eventTimeStamp.tag, NULL);
zassert_equal(
testAlarmAckIn.eventStateAcked, testAlarmAckOut.eventStateAcked, NULL);
data.eventTimeStamp.value.time.hour,
test_data.eventTimeStamp.value.time.hour, NULL);
zassert_equal(
data.eventTimeStamp.value.time.min,
test_data.eventTimeStamp.value.time.min, NULL);
zassert_equal(
data.eventTimeStamp.value.time.sec,
test_data.eventTimeStamp.value.time.sec, NULL);
zassert_equal(
data.eventTimeStamp.value.time.hundredths,
test_data.eventTimeStamp.value.time.hundredths, NULL);
status = bacapp_timestamp_init_ascii(
&testAlarmAckIn.eventTimeStamp, "2021/12/31");
zassert_equal(data.eventStateAcked, test_data.eventStateAcked, NULL);
status = bacapp_timestamp_init_ascii(&data.eventTimeStamp, "2021/12/31");
zassert_true(status, NULL);
zassert_equal(testAlarmAckIn.eventTimeStamp.tag, TIME_STAMP_DATETIME, NULL);
inLen = alarm_ack_encode_service_request(buffer, &testAlarmAckIn);
outLen = alarm_ack_decode_service_request(buffer, inLen, &testAlarmAckOut);
zassert_equal(inLen, outLen, "inlen=%d outlen=%d", inLen, outLen);
zassert_equal(data.eventTimeStamp.tag, TIME_STAMP_DATETIME, NULL);
apdu_len = bacnet_acknowledge_alarm_info_request_encode(apdu, sizeof(apdu), &data);
null_len = bacnet_acknowledge_alarm_info_request_encode(NULL, apdu_len, &data);
zassert_equal(null_len, apdu_len, NULL);
test_len = alarm_ack_decode_service_request(apdu, apdu_len, &test_data);
zassert_equal(
apdu_len, test_len, "apdu_len=%d test_len=%d", apdu_len, test_len);
status =
bacapp_timestamp_init_ascii(&testAlarmAckIn.eventTimeStamp, "1234");
status = bacapp_timestamp_init_ascii(&data.eventTimeStamp, "1234");
zassert_true(status, NULL);
zassert_equal(testAlarmAckIn.eventTimeStamp.tag, TIME_STAMP_SEQUENCE, NULL);
inLen = alarm_ack_encode_service_request(buffer, &testAlarmAckIn);
outLen = alarm_ack_decode_service_request(buffer, inLen, &testAlarmAckOut);
zassert_equal(inLen, outLen, "inlen=%d outlen=%d", inLen, outLen);
zassert_equal(data.eventTimeStamp.tag, TIME_STAMP_SEQUENCE, NULL);
apdu_len = bacnet_acknowledge_alarm_info_request_encode(apdu, sizeof(apdu), &data);
null_len = bacnet_acknowledge_alarm_info_request_encode(NULL, apdu_len, &data);
zassert_equal(null_len, apdu_len, NULL);
test_len = alarm_ack_decode_service_request(apdu, apdu_len, &test_data);
zassert_equal(
apdu_len, test_len, "apdu_len=%d test_len=%d", apdu_len, test_len);
while (--apdu_len) {
test_len = bacnet_acknowledge_alarm_info_request_encode(apdu, apdu_len, &data);
zassert_equal(test_len, 0, "apdu_len=%d test_len=%d", apdu_len, test_len);
}
apdu_len = null_len;
while (--apdu_len) {
test_len = alarm_ack_decode_service_request(apdu, apdu_len, &data);
zassert_true(test_len < 0, "apdu_len=%d test_len=%d", apdu_len, test_len);
}
}
/**