dali/bacnet_stack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added a basic example Auditlog object. (#458)

Browse Source 
Co-authored-by: Steve Karg <skarg@users.sourceforge.net>
This commit is contained in:
Mikhail Antropov
2025-06-23 20:18:13 +03:00
committed by GitHub
parent 464be15bae
commit 267db756b8
12 changed files with 3618 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/bacnet/basic/object/auditlog/CMakeLists.txt
+73
View File
@@ -0,0 +1,73 @@
# SPDX-License-Identifier: MIT
cmake_minimum_required(VERSION 3.10 FATAL_ERROR)
get_filename_component(basename ${CMAKE_CURRENT_SOURCE_DIR} NAME)
project(test_${basename}
VERSION 1.0.0
LANGUAGES C)
string(REGEX REPLACE
"/test/bacnet/[a-zA-Z_/-]*$"
"/src"
SRC_DIR
${CMAKE_CURRENT_SOURCE_DIR})
string(REGEX REPLACE
"/test/bacnet/[a-zA-Z_/-]*$"
"/test"
TST_DIR
${CMAKE_CURRENT_SOURCE_DIR})
set(ZTST_DIR "${TST_DIR}/ztest/src")
add_compile_definitions(
BIG_ENDIAN=0
CONFIG_ZTEST=1
BACAPP_MINIMAL=1
BACAPP_DATETIME=1
)
include_directories(
${SRC_DIR}
${TST_DIR}/ztest/include
${TST_DIR}/bacnet/basic/object/test
)
add_executable(${PROJECT_NAME}
# File(s) under test
${SRC_DIR}/bacnet/basic/object/auditlog.c
# Support files and stubs (pathname alphabetical)
${SRC_DIR}/bacnet/bacaddr.c
${SRC_DIR}/bacnet/bacaudit.c
${SRC_DIR}/bacnet/bacapp.c
${SRC_DIR}/bacnet/bacdcode.c
${SRC_DIR}/bacnet/bacdest.c
${SRC_DIR}/bacnet/bacdevobjpropref.c
${SRC_DIR}/bacnet/bacerror.c
${SRC_DIR}/bacnet/bacint.c
${SRC_DIR}/bacnet/bacreal.c
${SRC_DIR}/bacnet/bacstr.c
${SRC_DIR}/bacnet/bactext.c
${SRC_DIR}/bacnet/basic/sys/bigend.c
${SRC_DIR}/bacnet/basic/sys/debug.c
${SRC_DIR}/bacnet/basic/sys/keylist.c
${SRC_DIR}/bacnet/basic/sys/days.c
${SRC_DIR}/bacnet/datetime.c
${SRC_DIR}/bacnet/dcc.c
${SRC_DIR}/bacnet/indtext.c
${SRC_DIR}/bacnet/hostnport.c
${SRC_DIR}/bacnet/lighting.c
${SRC_DIR}/bacnet/timestamp.c
${SRC_DIR}/bacnet/wp.c
${SRC_DIR}/bacnet/weeklyschedule.c
${SRC_DIR}/bacnet/bactimevalue.c
${SRC_DIR}/bacnet/dailyschedule.c
${SRC_DIR}/bacnet/proplist.c
# Test and test library files
./src/main.c
${TST_DIR}/bacnet/basic/object/test/property_test.c
${TST_DIR}/bacnet/basic/object/test/device_mock.c
${TST_DIR}/bacnet/basic/object/test/datetime_local.c
${ZTST_DIR}/ztest_mock.c
${ZTST_DIR}/ztest.c
)
test/bacnet/basic/object/auditlog/src/main.c
+200
View File
@@ -0,0 +1,200 @@
/*
* Copyright (c) 2023 Legrand North America, LLC.
*
* SPDX-License-Identifier: MIT
*/
/* @file
* @brief test BACnet auditlog APIs
*/
#include <zephyr/ztest.h>
#include <bacnet/basic/object/auditlog.h>
#include <bacnet/bactext.h>
#include <bacnet/basic/object/device.h>
#include <property_test.h>
/**
* @addtogroup bacnet_tests
* @{
*/
/**
* @brief Test Auditlog handling
*/
static void testAuditlog(void)
{
int len = 0, index = 0;
const uint32_t instance = 1;
uint32_t test_instance = 0;
const int skip_fail_property_list[] = { -1 };
bool status = false;
BACNET_WRITE_PROPERTY_DATA wp_data = { 0 };
uint32_t buffer_size = 0;
Audit_Log_Init();
len = Audit_Log_Count();
zassert_true(len == 0, NULL);
status = Audit_Log_Valid_Instance(instance);
zassert_false(status, NULL);
test_instance = Audit_Log_Create(instance);
zassert_true(test_instance == instance, NULL);
len = Audit_Log_Count();
zassert_true(len == 1, NULL);
test_instance = Audit_Log_Index_To_Instance(0);
zassert_true(test_instance == instance, NULL);
index = Audit_Log_Instance_To_Index(instance);
zassert_true(index == 0, NULL);
status = Audit_Log_Valid_Instance(instance);
zassert_true(status, NULL);
/* configure ReadProperty test */
/* perform a general test for RP/WP */
bacnet_object_properties_read_write_test(
OBJECT_AUDIT_LOG, instance, Audit_Log_Property_Lists,
Audit_Log_Read_Property, Audit_Log_Write_Property,
skip_fail_property_list);
wp_data.object_type = OBJECT_AUDIT_LOG;
wp_data.object_instance = instance;
wp_data.priority = BACNET_NO_PRIORITY;
wp_data.array_index = BACNET_ARRAY_ALL;
/* test buffer size */
buffer_size = 512;
wp_data.object_property = PROP_BUFFER_SIZE;
wp_data.application_data_len =
encode_application_unsigned(wp_data.application_data, buffer_size);
status = Audit_Log_Write_Property(&wp_data);
zassert_true(status, NULL);
buffer_size = INT_MAX;
buffer_size++;
wp_data.application_data_len =
encode_application_unsigned(wp_data.application_data, buffer_size);
status = Audit_Log_Write_Property(&wp_data);
/* error out of range */
zassert_false(status, NULL);
zassert_equal(wp_data.error_class, ERROR_CLASS_PROPERTY, NULL);
zassert_equal(wp_data.error_code, ERROR_CODE_VALUE_OUT_OF_RANGE, NULL);
wp_data.object_property = PROP_ENABLE;
wp_data.application_data_len =
encode_application_boolean(wp_data.application_data, true);
status = Audit_Log_Write_Property(&wp_data);
zassert_true(status, NULL);
wp_data.object_property = PROP_BUFFER_SIZE;
wp_data.application_data_len =
encode_application_unsigned(wp_data.application_data, buffer_size);
status = Audit_Log_Write_Property(&wp_data);
/* error when enabled=true */
zassert_false(status, NULL);
zassert_equal(wp_data.error_class, ERROR_CLASS_PROPERTY, NULL);
zassert_equal(wp_data.error_code, ERROR_CODE_WRITE_ACCESS_DENIED, NULL);
/* test object name */
bacnet_object_name_ascii_test(
instance, Audit_Log_Name_Set, Audit_Log_Name_ASCII);
bacnet_object_name_ascii_test(
instance, Audit_Log_Description_Set, Audit_Log_Description);
status = Audit_Log_Delete(instance);
zassert_true(status, NULL);
Audit_Log_Cleanup();
len = Audit_Log_Count();
zassert_true(len == 0, NULL);
status = Audit_Log_Valid_Instance(instance);
zassert_false(status, NULL);
}
static void testLogs(void)
{
const uint32_t instance = 1;
uint32_t test_instance = 0;
int len = 0;
uint32_t buffer_size = 0, test_buffer_size = 0, original_buffer_size = 0;
uint32_t record_count = 0;
uint32_t total_record_count = 0;
bool status = false;
BACNET_AUDIT_LOG_RECORD *record;
Audit_Log_Init();
test_instance = Audit_Log_Create(instance);
zassert_true(test_instance == instance, NULL);
len = Audit_Log_Count();
zassert_true(len > 0, NULL);
/* Log Buffer settings */
buffer_size = Audit_Log_Buffer_Size(instance);
zassert_true(buffer_size > 0, NULL);
buffer_size = INT_MAX;
buffer_size++;
status = Audit_Log_Buffer_Size_Set(instance, buffer_size);
zassert_false(status, NULL);
original_buffer_size = Audit_Log_Buffer_Size(instance);
buffer_size = original_buffer_size / 2;
status = Audit_Log_Buffer_Size_Set(instance, buffer_size);
zassert_true(status, NULL);
test_buffer_size = Audit_Log_Buffer_Size(instance);
zassert_true(test_buffer_size == buffer_size, NULL);
status = Audit_Log_Buffer_Size_Set(instance, original_buffer_size);
zassert_true(status, NULL);
/* Log Buffer records manipulation */
record_count = Audit_Log_Record_Count(instance);
zassert_true(record_count == 0, NULL);
total_record_count = Audit_Log_Total_Record_Count(instance);
zassert_true(total_record_count == 0, NULL);
status = Audit_Log_Enable(instance);
zassert_false(status, NULL);
status = Audit_Log_Enable_Set(instance, false);
zassert_true(status, NULL);
/* start logging */
status = Audit_Log_Enable_Set(instance, true);
zassert_true(status, NULL);
record_count = Audit_Log_Record_Count(instance);
zassert_true(record_count == 1, NULL);
total_record_count = Audit_Log_Total_Record_Count(instance);
zassert_true(total_record_count == 1, NULL);
record = Audit_Log_Record_Entry(instance, 0);
zassert_not_null(record, NULL);
zassert_true(record->tag == AUDIT_LOG_DATUM_TAG_STATUS, NULL);
zassert_true(
BIT_CHECK(record->log_datum.log_status, LOG_STATUS_LOG_DISABLED) == 0,
NULL);
Audit_Log_Record_Status_Insert(instance, LOG_STATUS_LOG_INTERRUPTED, true);
record_count = Audit_Log_Record_Count(instance);
zassert_true(record_count == 2, NULL);
total_record_count = Audit_Log_Total_Record_Count(instance);
zassert_true(total_record_count == 2, NULL);
record = Audit_Log_Record_Entry(instance, 1);
zassert_not_null(record, NULL);
zassert_true(record->tag == AUDIT_LOG_DATUM_TAG_STATUS, NULL);
zassert_true(
BIT_CHECK(record->log_datum.log_status, LOG_STATUS_LOG_INTERRUPTED),
NULL);
Audit_Log_Record_Entry_Delete(instance, 1);
record_count = Audit_Log_Record_Count(instance);
zassert_true(record_count == 1, "record_count: %d", record_count);
total_record_count = Audit_Log_Total_Record_Count(instance);
zassert_true(total_record_count == 2, NULL);
record = Audit_Log_Record_Entry(instance, 0);
zassert_not_null(record, NULL);
zassert_true(record->tag == AUDIT_LOG_DATUM_TAG_STATUS, NULL);
zassert_true(
BIT_CHECK(record->log_datum.log_status, LOG_STATUS_LOG_DISABLED) == 0,
NULL);
Audit_Log_Cleanup();
}
/**
* @}
*/
void test_main(void)
{
ztest_test_suite(
auditlog_tests, ztest_unit_test(testAuditlog),
ztest_unit_test(testLogs));
ztest_run_test_suite(auditlog_tests);
}