Files
STM32F4-Base/IEC60870-Slave/test/iec60870_user_log_test.c
T
STF bdcc8b6500
CI / L0 静态门禁 (pre-commit) (push) Failing after 7m46s
CI / L0.5 主机侧单测 (MSVC) (push) Successful in 21s
添加遥控、参数装载、文件传输等业务
2026-11-16 22:19:17 -08:00

380 lines
18 KiB
C

/* 附录 C 核心单测:使用调用方内存介质,模拟提交前失败及提交后报告失败。 */
#include "IEC60870_UserLog.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#define CHECK(expression) do { if (!(expression)) { \
fprintf(stderr, "FAIL line %d: %s\n", __LINE__, #expression); exit(1); \
} } while (0)
/* size=0 表示从未提交;非空槽保存真实 wire 字节,使格式/CRC检查走生产路径。 */
typedef struct {
size_t size;
uint8_t bytes[IEC60870_USER_LOG_WIRE_MAX];
} Cell;
typedef struct {
Cell cells[IEC60870_USER_LOG_CAPACITY];
unsigned commits;
int fail_commit; /* 0成功;1写入前失败;2已经更新介质却向调用方报告失败。 */
int fail_read; /* -1不注入;非负值指定一个读取失败的槽号。 */
} Store;
static Store storage;
static IEC60870_UserLog_t log_core;
/**
* 功能:按槽读取测试介质,支持指定槽报错。
* 输入参数:context——业务回调的测试上下文;index——待访问或核对的条目下标;bytes——报文字节缓冲区;capacity——调用方提供的缓冲容量;size——数据长度或文件大小。
* 输出参数:bytes——写入或读出的数据字节;size——本次数据、文件或 ASDU 的实际长度。
* 返回值:本次核心或后端操作的状态枚举,保留成功、空记录、拒绝及错误等区别。
* 说明:空槽返回EMPTY,成功才复制记录并写长度。
*/
static IEC60870_UserLogResult_t Read(void *context, uint32_t index,
uint8_t *bytes, size_t capacity, size_t *size)
{
Store *store = (Store *)context;
Cell *cell;
CHECK(index < IEC60870_USER_LOG_CAPACITY);
if (store->fail_read == (int)index) { return IEC60870_USER_LOG_ERROR; }
cell = &store->cells[index];
if (cell->size == 0U) { return IEC60870_USER_LOG_EMPTY; }
CHECK(cell->size <= capacity);
memcpy(bytes, cell->bytes, cell->size);
*size = cell->size;
return IEC60870_USER_LOG_OK;
}
/**
* 功能:统计提交并支持写入前拒绝、完整写入后报错两种故障,模拟持久化结果不确定。
* 输入参数:context——业务回调的测试上下文;index——待访问或核对的条目下标;bytes——报文字节缓冲区(只读);size——数据长度或文件大小。
* 输出参数:无。
* 返回值:true 表示本次操作或核对成功;false 表示拒绝、失败或命中注入故障。
* 说明:检查不满足时由 CHECK 立即报告失败,不继续本用例。
*/
static bool Commit(void *context, uint32_t index, const uint8_t *bytes, size_t size)
{
Store *store = (Store *)context;
CHECK(index < IEC60870_USER_LOG_CAPACITY && size <= IEC60870_USER_LOG_WIRE_MAX);
++store->commits;
if (store->fail_commit == 1) { return false; }
memcpy(store->cells[index].bytes, bytes, size);
store->cells[index].size = size;
return store->fail_commit != 2;
}
/**
* 功能:保留介质、只重建核心,模拟重启扫描。
* 输入参数:无。
* 输出参数:无。
* 返回值:本次核心或后端操作的状态枚举,保留成功、空记录、拒绝及错误等区别。
* 说明:不借用上一次恢复的序号或计数。
*/
static IEC60870_UserLogResult_t Recover(void)
{
IEC60870_UserLogStore_t store = {&storage, Read, Commit};
return IEC60870_UserLog_Init(&log_core, &store);
}
/**
* 功能:每组从空介质开始,明确关闭故障注入,避免前组损坏影响当前断言。
* 输入参数:无。
* 输出参数:无。
* 返回值:无。
* 说明:检查不满足时由 CHECK 立即报告失败,不继续本用例。
*/
static void Fresh(void)
{
memset(&storage, 0, sizeof(storage));
storage.fail_read = -1;
CHECK(Recover() == IEC60870_USER_LOG_OK);
}
/**
* 功能:构造 CRC 正确但语义非法的记录,检验恢复不只依赖完整性校验。
* 输入参数:bytes——报文字节缓冲区;value——测试对象值或原始位模式;length——字节长度。
* 输出参数:bytes——写入或读出的数据字节。
* 返回值:无。
* 说明:本辅助入口用于构造或核对上述测试场景,相关状态保存在当前测试夹具中。
*/
static void Put(uint8_t *bytes, uint64_t value, size_t length)
{
size_t i;
for (i = 0U; i < length; ++i) { bytes[i] = (uint8_t)(value >> (i * 8U)); }
}
/**
* 功能:为已篡改记录重算CRC32并小端写回末四字节,使后续恢复单独检验语义合法性。
* 输入参数:cell——可改写的内存记录槽。
* 输出参数:cell——正文或 CRC 被改写后的记录槽。
* 返回值:无。
* 说明:本辅助入口用于构造或核对上述测试场景,相关状态保存在当前测试夹具中。
*/
static void Recheck(Cell *cell)
{
uint32_t crc = UINT32_MAX;
size_t i;
unsigned bit;
for (i = 0U; i < cell->size - 4U; ++i) {
crc ^= cell->bytes[i];
for (bit = 0U; bit < 8U; ++bit) {
crc = (crc >> 1) ^ ((crc & 1U) != 0U ? UINT32_C(0xedb88320) : 0U);
}
}
Put(cell->bytes + cell->size - 4U, ~crc, 4U);
}
/**
* 功能:空库与错误返回、失败输出不变,以及 Init 的回调表别名和基本 wire字段。
* 输入参数:无。
* 输出参数:无。
* 返回值:无。
* 说明:检查不满足时由 CHECK 立即报告失败,不继续本用例。
*/
static void Empty_And_Alias(void)
{
IEC60870_UserLog_t before;
IEC60870_UserLogRecord_t record, unchanged;
IEC60870_UserLogStore_t bad = {NULL, NULL, Commit};
uint64_t time = 123U;
Fresh();
memset(&record, 0x5a, sizeof(record)); unchanged = record;
CHECK(IEC60870_UserLog_Count(&log_core) == 0U);
CHECK(IEC60870_UserLog_Count(NULL) == 0U);
CHECK(IEC60870_UserLog_Get(&log_core, 0U, &record) == IEC60870_USER_LOG_EMPTY);
CHECK(memcmp(&record, &unchanged, sizeof(record)) == 0);
CHECK(!IEC60870_UserLog_Latest_Time(&log_core, &time) && time == 123U);
CHECK(!IEC60870_UserLog_Latest_Time(NULL, &time));
CHECK(!IEC60870_UserLog_Latest_Time(&log_core, NULL));
CHECK(IEC60870_UserLog_Get(NULL, 0U, &record) == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Get(&log_core, 0U, NULL) == IEC60870_USER_LOG_INVALID);
before = log_core;
CHECK(IEC60870_UserLog_Init(&log_core, &bad) == IEC60870_USER_LOG_INVALID);
CHECK(memcmp(&before, &log_core, sizeof(before)) == 0);
CHECK(IEC60870_UserLog_Init(&log_core, NULL) == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Init(NULL, &log_core.store) == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Append(NULL, 1U, IEC60870_USER_LOG_UTC_MIN, 1U, "boot") == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Append(&log_core, 1U, IEC60870_USER_LOG_UTC_MIN, 1U, "boot") == IEC60870_USER_LOG_OK);
CHECK(IEC60870_UserLog_Init(&log_core, &log_core.store) == IEC60870_USER_LOG_OK);
CHECK(log_core.store.context == &storage && IEC60870_UserLog_Count(&log_core) == 1U);
CHECK(IEC60870_UserLog_Get(&log_core, 0U, &record) == IEC60870_USER_LOG_OK);
CHECK(record.sequence == 1U && strcmp(record.text, "boot") == 0);
CHECK(storage.cells[0].size == 40U && memcmp(storage.cells[0].bytes, "ULG1", 4U) == 0);
CHECK(storage.cells[0].bytes[4] == 1U && storage.cells[0].bytes[6] == 4U &&
storage.cells[0].bytes[8] == 1U && storage.cells[0].bytes[24] == 1U && storage.cells[0].bytes[25] == 1U);
}
/**
* 功能:穷举11种类别的两种状态值。
* 输入参数:无。
* 输出参数:无。
* 返回值:无。
* 说明:覆盖ASCII长度/控制字节、日历两端及回拨。
* 同类别同值来自另一来源仍应追加,验证核心没有错误的全局类别去重。
*/
static void Types_Text_And_Time(void)
{
IEC60870_UserLogRecord_t record;
char text[IEC60870_USER_LOG_TEXT_MAX + 2U];
unsigned type, value, expected = 0U;
size_t i;
uint64_t time;
Fresh();
for (type = 1U; type <= 11U; ++type) {
for (value = 0U; value <= 1U; ++value) {
bool valid = value == 1U || (type >= 2U && type <= 9U);
CHECK(IEC60870_UserLog_Append(&log_core, (uint8_t)type, IEC60870_USER_LOG_UTC_MIN,
(uint8_t)value, "source transition") ==
(valid ? IEC60870_USER_LOG_OK : IEC60870_USER_LOG_INVALID));
if (valid) { ++expected; }
CHECK(IEC60870_UserLog_Count(&log_core) == expected);
}
}
CHECK(expected == 19U);
CHECK(IEC60870_UserLog_Append(&log_core, 0U, IEC60870_USER_LOG_UTC_MIN, 1U, "x") == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Append(&log_core, 12U, IEC60870_USER_LOG_UTC_MIN, 1U, "x") == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN, 2U, "x") == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN - 1U, 0U, "x") == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MAX + 1U, 0U, "x") == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Append(&log_core, 2U, UINT64_MAX, 0U, "x") == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN, 0U, NULL) == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN, 0U, "") == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN, 0U, "a\tb") == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN, 0U, "\x7f") == IEC60870_USER_LOG_INVALID);
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN, 0U, "\x80") == IEC60870_USER_LOG_INVALID);
for (i = 0U; i < IEC60870_USER_LOG_TEXT_MAX; ++i) { text[i] = (char)(0x20U + i % 95U); }
text[IEC60870_USER_LOG_TEXT_MAX] = '\0';
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MAX, 0U, text) == IEC60870_USER_LOG_OK);
CHECK(storage.cells[expected].size == IEC60870_USER_LOG_WIRE_MAX);
CHECK(IEC60870_UserLog_Get(&log_core, expected, &record) == IEC60870_USER_LOG_OK);
CHECK(strcmp(record.text, text) == 0 && record.utc_ms == IEC60870_USER_LOG_UTC_MAX);
text[IEC60870_USER_LOG_TEXT_MAX] = 'x'; text[IEC60870_USER_LOG_TEXT_MAX + 1U] = '\0';
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN, 0U, text) == IEC60870_USER_LOG_INVALID);
/* 相同类别/值允许不同来源,时标回拨也不会被核心去重或排序。 */
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN, 0U, "another source") == IEC60870_USER_LOG_OK);
CHECK(IEC60870_UserLog_Latest_Time(&log_core, &time) && time == IEC60870_USER_LOG_UTC_MIN);
CHECK(Recover() == IEC60870_USER_LOG_OK);
CHECK(IEC60870_UserLog_Latest_Time(&log_core, &time) && time == IEC60870_USER_LOG_UTC_MIN);
CHECK(IEC60870_UserLog_Count(&log_core) == expected + 2U);
}
/**
* 功能:第1025条覆盖序号1,重启后逻辑读取必须为2..1025,即使时间逐条倒退。
* 输入参数:无。
* 输出参数:无。
* 返回值:无。
* 说明:从已满环删去中间槽后必须拒绝恢复,不能静默缩小日志条数。
*/
static void Rotation_And_Restart(void)
{
IEC60870_UserLogRecord_t record;
unsigned i;
Fresh();
for (i = 1U; i <= 1025U; ++i) {
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN + 2048U - i,
(uint8_t)(i % 2U), "line state") == IEC60870_USER_LOG_OK);
}
CHECK(IEC60870_UserLog_Count(&log_core) == 1024U);
CHECK(Recover() == IEC60870_USER_LOG_OK);
for (i = 0U; i < 1024U; ++i) {
CHECK(IEC60870_UserLog_Get(&log_core, i, &record) == IEC60870_USER_LOG_OK);
CHECK(record.sequence == i + 2U && record.utc_ms == IEC60870_USER_LOG_UTC_MIN + 2046U - i);
}
CHECK(IEC60870_UserLog_Get(&log_core, 1024U, &record) == IEC60870_USER_LOG_EMPTY);
storage.cells[99].size = 0U;
CHECK(Recover() == IEC60870_USER_LOG_ERROR && !log_core.initialized);
}
/**
* 功能:分别模拟提交前失败和已提交但返回失败,两者都先闭锁,重扫才辨明事实。
* 输入参数:无。
* 输出参数:无。
* 返回值:无。
* 说明:同时验证查询输出保留、后续调用不再次提交、读取错误和真实CRC损坏。
*/
static void Uncertain_Commit_And_Read_Error(void)
{
IEC60870_UserLogRecord_t record, before;
unsigned commits;
Fresh();
CHECK(IEC60870_UserLog_Append(&log_core, 1U, IEC60870_USER_LOG_UTC_MIN, 1U, "boot") == IEC60870_USER_LOG_OK);
storage.fail_commit = 1;
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN, 1U, "line") == IEC60870_USER_LOG_ERROR);
CHECK(log_core.faulted && log_core.sequence == 1U && log_core.count == 1U);
commits = storage.commits;
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN, 0U, "line") == IEC60870_USER_LOG_ERROR);
CHECK(commits == storage.commits && IEC60870_UserLog_Count(&log_core) == 0U);
memset(&record, 0xa5, sizeof(record)); before = record;
CHECK(IEC60870_UserLog_Get(&log_core, 0U, &record) == IEC60870_USER_LOG_ERROR);
CHECK(memcmp(&record, &before, sizeof(record)) == 0);
storage.fail_commit = 0;
CHECK(Recover() == IEC60870_USER_LOG_OK && log_core.sequence == 1U);
storage.fail_commit = 2;
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN, 1U, "line") == IEC60870_USER_LOG_ERROR);
CHECK(log_core.sequence == 1U && log_core.count == 1U);
storage.fail_commit = 0;
CHECK(Recover() == IEC60870_USER_LOG_OK && log_core.sequence == 2U && log_core.count == 2U);
storage.fail_read = 1;
CHECK(IEC60870_UserLog_Get(&log_core, 1U, &record) == IEC60870_USER_LOG_ERROR);
CHECK(log_core.faulted && memcmp(&record, &before, sizeof(record)) == 0);
CHECK(Recover() == IEC60870_USER_LOG_ERROR && !log_core.initialized);
storage.fail_read = -1;
CHECK(Recover() == IEC60870_USER_LOG_OK);
storage.cells[0].bytes[32] ^= 1U;
CHECK(IEC60870_UserLog_Get(&log_core, 0U, &record) == IEC60870_USER_LOG_ERROR && log_core.faulted);
CHECK(Recover() == IEC60870_USER_LOG_ERROR);
}
/**
* 功能:修改魔数/版本/保留位/长度/槽号/时间/值/文本后重算CRC,要求语义校验拒绝。
* 输入参数:无。
* 输出参数:无。
* 返回值:无。
* 说明:随后删去未满环的首条,验证合法后续记录不能掩盖序号缺口。
*/
static void Malformed_And_Missing(void)
{
Cell valid;
unsigned variant;
Fresh();
CHECK(IEC60870_UserLog_Append(&log_core, 1U, IEC60870_USER_LOG_UTC_MIN, 1U, "boot") == IEC60870_USER_LOG_OK);
valid = storage.cells[0];
for (variant = 0U; variant < 12U; ++variant) {
Cell *cell = &storage.cells[0];
*cell = valid;
switch (variant) {
case 0U: cell->bytes[0] = 'X'; break;
case 1U: cell->bytes[4] = 2U; break;
case 2U: cell->bytes[5] = 1U; break;
case 3U: cell->bytes[6] = 5U; break;
case 4U: Put(cell->bytes + 8U, 0U, 8U); break;
case 5U: Put(cell->bytes + 8U, 2U, 8U); break;
case 6U: Put(cell->bytes + 16U, IEC60870_USER_LOG_UTC_MIN - 1U, 8U); break;
case 7U: cell->bytes[24] = 12U; break;
case 8U: cell->bytes[25] = 0U; break;
case 9U: cell->bytes[31] = 1U; break;
case 10U: cell->bytes[32] = 0U; break;
default: --cell->size; break;
}
Recheck(cell);
CHECK(Recover() == IEC60870_USER_LOG_ERROR);
}
storage.cells[0] = valid;
CHECK(Recover() == IEC60870_USER_LOG_OK);
CHECK(IEC60870_UserLog_Append(&log_core, 2U, IEC60870_USER_LOG_UTC_MIN, 1U, "line") == IEC60870_USER_LOG_OK);
storage.cells[0].size = 0U;
CHECK(Recover() == IEC60870_USER_LOG_ERROR);
}
/**
* 功能:直接构造接近64位上限的完整合法环,避免不可行的逐条追加。
* 输入参数:无。
* 输出参数:无。
* 返回值:无。
* 说明:耗尽后拒绝写入,
* 仍能读取最旧及最新记录,且不能误置介质故障或复用序号0。
*/
static void Sequence_Exhaustion(void)
{
Cell model;
IEC60870_UserLogRecord_t record;
uint64_t sequence;
unsigned i, commits;
Fresh();
CHECK(IEC60870_UserLog_Append(&log_core, 1U, IEC60870_USER_LOG_UTC_MIN, 1U, "boot") == IEC60870_USER_LOG_OK);
model = storage.cells[0];
for (i = 0U; i < IEC60870_USER_LOG_CAPACITY; ++i) {
Cell *cell;
sequence = UINT64_MAX - (IEC60870_USER_LOG_CAPACITY - 1U) + i;
cell = &storage.cells[(sequence - 1U) % IEC60870_USER_LOG_CAPACITY];
*cell = model;
Put(cell->bytes + 8U, sequence, 8U);
Recheck(cell);
}
CHECK(Recover() == IEC60870_USER_LOG_OK && log_core.sequence == UINT64_MAX);
CHECK(IEC60870_UserLog_Get(&log_core, 0U, &record) == IEC60870_USER_LOG_OK &&
record.sequence == UINT64_MAX - 1023U);
CHECK(IEC60870_UserLog_Get(&log_core, 1023U, &record) == IEC60870_USER_LOG_OK &&
record.sequence == UINT64_MAX);
commits = storage.commits;
CHECK(IEC60870_UserLog_Append(&log_core, 1U, IEC60870_USER_LOG_UTC_MIN, 1U, "boot") == IEC60870_USER_LOG_ERROR);
CHECK(storage.commits == commits && log_core.sequence == UINT64_MAX && !log_core.faulted);
}
/**
* 功能:运行日志输入、环覆盖、重启恢复、模糊提交、记录损坏及序号耗尽回归。
* 输入参数:无。
* 输出参数:无。
* 返回值:正常完成返回 0;参数、运行或断言失败以非零状态结束进程。
* 说明:本辅助入口用于构造或核对上述测试场景,相关状态保存在当前测试夹具中。
*/
int main(void)
{
Empty_And_Alias(); Types_Text_And_Time(); Rotation_And_Restart();
Uncertain_Commit_And_Read_Error(); Malformed_And_Missing(); Sequence_Exhaustion();
puts("UserLog core: 6 groups passed");
return 0;
}