Files
STM32F4-Base/IEC60870-Slave/test/iec104_example_upgrade_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

736 lines
35 KiB
C

/* 实文件升级测试:真实分段负载、安装与备份逐字节比对、同步边界故障和重开恢复。
* 只在传入父目录下创建唯一子目录,按固定文件名清理,不递归删除。
* 注入点在系统同步完成之后,不能替代目标硬件突然断电验收。 */
#include "iec104_example_upgrade.h"
#include <assert.h>
#include <stdio.h>
#include <string.h>
#include <windows.h>
static ExampleUpgrade storage, second; /* 静态清零;second 专门验证同目录独占及失败打开的资源边界。 */
static unsigned interrupt_after, observed; /* 前者倒数至指定返回点,后者统计实际已经完成的同步操作。 */
/* 唯一子目录内允许创建的固定文件集合,复制与清理使用同一清单,遗漏文件会使 rmdir 断言失败。 */
static const char *const names[] = {
"upgrade.store", "upgrade-slot0.bin", "upgrade-slot1.bin", "upgrade-slot2.bin",
"dtu", "dtu-1", "dtu.new", "dtu-1.new", "seed.pkg"
};
/**
* 功能:在指定真实同步或替换完成点注入中断,仅拒绝本轮选定的一次操作。
* 输入参数:point——同步或替换完成点编号。
* 输出参数:无。
* 返回值:true 允许继续当前持久操作;false 表示命中本轮指定中断点。
* 说明:只在测试宏下链接;不替换系统写入,恰在第 N 个真实同步/替换完成后拒绝成功。
* 一次失败不会在后续点重复触发;用例仍立即停止动作并关闭,避免模拟出继续写入。
*/
bool Example_Upgrade_Test_Continue(unsigned point)
{
assert(point >= 1U && point <= 8U);
++observed;
return interrupt_after == 0U || --interrupt_after != 0U;
}
/**
* 功能:只拼接夹具已知文件名,调用方始终提供 MAX_PATH 缓冲,长度异常立即终止用例。
* 输入参数:directory——测试目录路径(只读);name——测试文件名(只读);path——测试路径。
* 输出参数:path——生成的测试目录或文件路径。
* 返回值:无。
* 说明:本辅助入口用于构造或核对上述测试场景,相关状态保存在当前测试夹具中。
*/
static void Path(const char *directory, const char *name, char *path)
{
int length = snprintf(path, MAX_PATH, "%s/%s", directory, name);
assert(length > 0 && length < MAX_PATH);
}
/**
* 功能:系统唯一临时名字仅用于取得新子目录。
* 输入参数:parent——测试父目录(只读);directory——测试目录路径。
* 输出参数:directory——生成的测试目录或文件路径。
* 返回值:无。
* 说明:所有持久故障用例相互隔离。
*/
static void New_Directory(const char *parent, char *directory)
{
assert(GetTempFileNameA(parent, "uft", 0U, directory));
assert(DeleteFileA(directory));
assert(CreateDirectoryA(directory, NULL));
}
/**
* 功能:删除当前用例拥有的已知持久文件和空测试目录。
* 输入参数:directory——测试目录路径(只读)。
* 输出参数:无。
* 返回值:无。
* 说明:后端须先 Close;逐一删除本用例拥有的已知文件,不递归清理任意传入路径。
* 删除失败可以暴露遗漏句柄或未登记的残留文件,不能忽略这些资源问题。
*/
static void Remove_Directory(const char *directory)
{
size_t i;
char path[MAX_PATH];
for (i = 0U; i < sizeof(names) / sizeof(names[0]); ++i) {
Path(directory, names[i], path);
if (!DeleteFileA(path)) { assert(GetLastError() == ERROR_FILE_NOT_FOUND); }
}
assert(RemoveDirectoryA(directory));
}
/**
* 功能:将已关闭的完整基线复制到独立测试目录,隔离各个中断场景。
* 输入参数:parent——测试父目录(只读);source——源路径(只读);destination——目标路径缓冲区。
* 输出参数:destination——生成的测试目录或文件路径。
* 返回值:无。
* 说明:基线已关闭且内容稳定;每个中断场景从相同真实档案复制,不继承上一轮损坏。
*/
static void Copy_Directory(const char *parent, const char *source, char *destination)
{
size_t i;
char from[MAX_PATH], to[MAX_PATH];
New_Directory(parent, destination);
for (i = 0U; i < sizeof(names) / sizeof(names[0]); ++i) {
Path(source, names[i], from); Path(destination, names[i], to);
if (GetFileAttributesA(from) != INVALID_FILE_ATTRIBUTES) { assert(CopyFileA(from, to, TRUE)); }
else { assert(GetLastError() == ERROR_FILE_NOT_FOUND); }
}
}
/**
* 功能:由版本及偏移产生可重复的负载,不保存整份映像。
* 输入参数:offset——文件、记录或缓冲区偏移;version——测试映像版本号。
* 输出参数:无。
* 返回值:由版本和偏移确定的单字节测试负载。
* 说明:安装比对可定位每个字节。
*/
static uint8_t Pattern(uint32_t offset, uint32_t version)
{
return (uint8_t)(offset * 37U + (offset >> 8) + version * 19U);
}
/**
* 功能:独立计算期望负载 CRC,包头与核对均不从被测后端读取其宣称的校验值。
* 输入参数:version——测试映像版本号;size——数据长度或文件大小。
* 输出参数:无。
* 返回值:独立计算得到的 32 位校验摘要。
* 说明:本辅助入口用于构造或核对上述测试场景,相关状态保存在当前测试夹具中。
*/
static uint32_t Payload_Crc(uint32_t version, uint32_t size)
{
uint32_t crc = UINT32_MAX, offset;
unsigned bit;
for (offset = 0U; offset < size; ++offset) {
crc ^= Pattern(offset, version);
for (bit = 0U; bit < 8U; ++bit) {
crc = (crc >> 1) ^ ((crc & 1U) != 0U ? UINT32_C(0xedb88320) : 0U);
}
}
return ~crc;
}
/**
* 功能:构造测试包和损坏元数据时显式小端编码,避免宿主对齐/字节序掩盖格式错误。
* 输入参数:bytes——报文字节缓冲区;value——测试对象值或原始位模式。
* 输出参数:bytes——写入或读出的数据字节。
* 返回值:无。
* 说明:本辅助入口用于构造或核对上述测试场景,相关状态保存在当前测试夹具中。
*/
static void Put32(uint8_t *bytes, uint32_t value)
{
unsigned i;
for (i = 0U; i < 4U; ++i) { bytes[i] = (uint8_t)(value >> (8U * i)); }
}
/**
* 功能:生成包含版本、长度及校验信息的 16 字节测试包头。
* 输入参数:bytes——报文字节缓冲区;version——测试映像版本号;size——数据长度或文件大小。
* 输出参数:bytes——写入或读出的数据字节。
* 返回值:无。
* 说明:包头 16 字节只描述后续负载;安装文件期望值完全不包含本段字节。
*/
static void Package_Header(uint8_t *bytes, uint32_t version, uint32_t size)
{
memcpy(bytes, "I104", 4U); Put32(bytes + 4U, version);
Put32(bytes + 8U, size); Put32(bytes + 12U, Payload_Crc(version, size));
}
/**
* 功能:夹具自身也拒绝短写,不能将创建坏测试输入的 I/O 失败误认成被测逻辑通过。
* 输入参数:file——已打开的测试文件句柄;bytes——报文字节缓冲区(只读);length——字节长度。
* 输出参数:无。
* 返回值:无。
* 说明:本辅助入口用于构造或核对上述测试场景,相关状态保存在当前测试夹具中。
*/
static void Write_All(HANDLE file, const uint8_t *bytes, size_t length)
{
DWORD done;
assert(WriteFile(file, bytes, (DWORD)length, &done, NULL) && done == length);
}
/**
* 功能:显式生成并同步真实初始工程包。
* 输入参数:directory——测试目录路径(只读);path——测试路径。
* 输出参数:path——生成的测试目录或文件路径。
* 返回值:无。
* 说明:版本 1 的 257 字节跨越复制缓冲边界。
* 它只用于首次 Provision,后续已有档案必须通过 NULL seed 恢复。
*/
static void Seed(const char *directory, char *path)
{
uint8_t bytes[256];
uint32_t offset;
HANDLE file;
Path(directory, "seed.pkg", path);
file = CreateFileA(path, GENERIC_READ | GENERIC_WRITE, 0U, NULL, CREATE_NEW, FILE_ATTRIBUTE_NORMAL, NULL);
assert(file != INVALID_HANDLE_VALUE);
Package_Header(bytes, 1U, 257U); Write_All(file, bytes, 16U);
for (offset = 0U; offset < 257U; ++offset) {
bytes[0] = Pattern(offset, 1U); Write_All(file, bytes, 1U);
}
assert(FlushFileBuffers(file)); assert(CloseHandle(file));
}
/**
* 功能:核对实际文件的精确长度和每个负载字节,不以元数据、CRC 相等或成功返回代替安装证据。
* 输入参数:directory——测试目录路径(只读);name——测试文件名(只读);version——测试映像版本号;expected——期望的结果或数量。
* 输出参数:无。
* 返回值:无。
* 说明:本辅助入口用于构造或核对上述测试场景,相关状态保存在当前测试夹具中。
*/
static void Check_File(const char *directory, const char *name, uint32_t version, uint32_t expected)
{
char path[MAX_PATH];
uint8_t bytes[256];
uint32_t offset = 0U;
LARGE_INTEGER size;
HANDLE file;
Path(directory, name, path);
file = CreateFileA(path, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
assert(file != INVALID_HANDLE_VALUE);
assert(GetFileSizeEx(file, &size) && size.QuadPart == expected);
while (offset < expected) {
DWORD done, amount = expected - offset, i;
if (amount > sizeof(bytes)) { amount = sizeof(bytes); }
assert(ReadFile(file, bytes, amount, &done, NULL) && done == amount);
for (i = 0U; i < amount; ++i) { assert(bytes[i] == Pattern(offset + i, version)); }
offset += amount;
}
assert(CloseHandle(file));
}
/**
* 功能:只接受确实不存在,不把拒绝访问等查询错误当作没有档案。
* 输入参数:directory——测试目录路径(只读);name——测试文件名(只读)。
* 输出参数:无。
* 返回值:无。
* 说明:本辅助入口用于构造或核对上述测试场景,相关状态保存在当前测试夹具中。
*/
static void Missing_File(const char *directory, const char *name)
{
char path[MAX_PATH];
Path(directory, name, path);
assert(GetFileAttributesA(path) == INVALID_FILE_ATTRIBUTES && GetLastError() == ERROR_FILE_NOT_FOUND);
}
/**
* 功能:检查对外公布的是已确认描述。
* 输入参数:version——测试映像版本号;size——数据长度或文件大小。
* 输出参数:无。
* 返回值:无。
* 说明:与 Check_File 分开,覆盖 TRIAL 的角色/安装内容差异。
*/
static void Check_Current(uint32_t version, uint32_t size)
{
IEC60870_FirmwareUpdateDescriptor_t descriptor;
assert(Example_Upgrade_Store_Current(&storage, &descriptor));
assert(descriptor.version == version && descriptor.size == size && descriptor.crc == Payload_Crc(version, size));
}
/**
* 功能:头部故意按 1/3/7/5 字节拆开,之后使用不对齐的小分片,覆盖跨头边界写入。
* 输入参数:version——测试映像版本号;size——数据长度或文件大小;corrupt——是否故意破坏声明的 CRC。
* 输出参数:无。
* 返回值:true 表示本次操作或核对成功;false 表示拒绝、失败或命中注入故障。
* 说明:corrupt 只破坏包头宣称的 CRC,负载仍正确;任一步 false 立即返回,供失败注入
* 用例验证没有继续后续授权/安装,也供正常用例显式执行 Abort。
*/
static bool Upload(uint32_t version, uint32_t size, bool corrupt)
{
uint8_t header[16], bytes[113];
uint32_t offset = 0U;
static const size_t first[] = {1U, 3U, 7U, 5U};
size_t piece = 0U;
Package_Header(header, version, size);
if (corrupt) { header[12] ^= 1U; }
if (!Example_Upgrade_Store_Candidate_Open(&storage, size + 16U)) { return false; }
while (offset < size + 16U) {
size_t amount = piece < sizeof(first) / sizeof(first[0]) ? first[piece] : sizeof(bytes), i;
if (amount > size + 16U - offset) { amount = size + 16U - offset; }
for (i = 0U; i < amount; ++i) {
uint32_t index = offset + (uint32_t)i;
bytes[i] = index < 16U ? header[index] : Pattern(index - 16U, version);
}
if (!Example_Upgrade_Store_Candidate_Write(&storage, offset, bytes, amount)) { return false; }
offset += (uint32_t)amount; ++piece;
}
return Example_Upgrade_Store_Candidate_Finish(&storage);
}
/**
* 功能:串行调用上传、授权、安装和确认。
* 输入参数:version——测试映像版本号;size——数据长度或文件大小。
* 输出参数:无。
* 返回值:true 表示本次操作或核对成功;false 表示拒绝、失败或命中注入故障。
* 说明:短路是测试中断边界,不模拟协议 ACK 或运行映像。
*/
static bool Upgrade(uint32_t version, uint32_t size)
{
return Upload(version, size, false) && Example_Upgrade_Store_Authorize(&storage) &&
Example_Upgrade_Store_Prepare_Boot(&storage) && Example_Upgrade_Store_Confirm(&storage);
}
/**
* 功能:证明缺 seed 首次拒绝不会留下空存储。
* 输入参数:parent——测试父目录(只读);directory——测试目录路径。
* 输出参数:directory——生成的测试目录或文件路径。
* 返回值:无。
* 说明:提供 seed 的 Open 只登记,还未产生 dtu。
* 显式 Prepare_Boot/Confirm 后得到已关闭、可复制的真实基线,尚无虚构 backup。
*/
static void Baseline(const char *parent, char *directory)
{
char seed[MAX_PATH];
New_Directory(parent, directory); Seed(directory, seed);
assert(!Example_Upgrade_Store_Open(&storage, directory, NULL));
Missing_File(directory, "upgrade.store");
assert(Example_Upgrade_Store_Open(&storage, directory, seed));
Missing_File(directory, "dtu");
assert(Example_Upgrade_Store_Prepare_Boot(&storage));
assert(Example_Upgrade_Store_Confirm(&storage));
Check_File(directory, "dtu", 1U, 257U); Missing_File(directory, "dtu-1");
Example_Upgrade_Store_Close(&storage);
}
/**
* 功能:覆盖重复 Open/跨实例锁、上传边界、低版本与坏 CRC、70KB 小缓冲流式、
* 未授权重启取消、已授权恢复安装、未确认回退及连续确认后的角色轮转。
* 输入参数:parent——测试父目录(只读);baseline——已关闭的持久基线目录(只读)。
* 输出参数:无。
* 返回值:无。
* 说明:本辅助入口用于构造或核对上述测试场景,相关状态保存在当前测试夹具中。
*/
static void Test_Lifecycle(const char *parent, const char *baseline)
{
char directory[MAX_PATH], seed[MAX_PATH];
IEC60870_FirmwareUpdateDescriptor_t descriptor;
uint8_t header[16];
Copy_Directory(parent, baseline, directory); Path(directory, "seed.pkg", seed);
assert(!Example_Upgrade_Store_Open(&storage, directory, seed));
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(!Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(!Example_Upgrade_Store_Open(&second, directory, NULL));
Check_Current(1U, 257U);
assert(Example_Upgrade_Store_Candidate_Abort(&storage));
assert(!Example_Upgrade_Store_Candidate_Open(&storage, 16U));
assert(!Example_Upgrade_Store_Candidate_Open(&storage, EXAMPLE_UPGRADE_PACKAGE_MAX + 1U));
assert(Example_Upgrade_Store_Candidate_Open(&storage, 17U));
Package_Header(header, 2U, 1U);
assert(!Example_Upgrade_Store_Candidate_Write(&storage, 1U, header, 1U));
assert(Example_Upgrade_Store_Candidate_Write(&storage, 0U, header, 15U));
assert(!Example_Upgrade_Store_Candidate_Finish(&storage));
assert(Example_Upgrade_Store_Candidate_Abort(&storage));
assert(!Upload(1U, 257U, false));
assert(Example_Upgrade_Store_Candidate_Abort(&storage));
/* 格式/CRC 不接受不是不确定提交;仍健康的未授权接收可撤销后重新上传。 */
assert(!Upload(2U, 513U, true));
assert(!storage.core.status.faulted);
assert(Example_Upgrade_Store_Candidate_Abort(&storage));
assert(Upload(2U, 70000U, false));
assert(Example_Upgrade_Store_Candidate_Info(&storage, &descriptor));
assert(descriptor.version == 2U && descriptor.size == 70000U);
Check_Current(1U, 257U); Check_File(directory, "dtu", 1U, 257U);
/* 未授权候选即使完整落盘,重开准备也只能取消,不能自行安装。 */
Example_Upgrade_Store_Close(&storage);
assert(Example_Upgrade_Store_Open(&storage, storage.parent, NULL));
assert(Example_Upgrade_Store_Prepare_Boot(&storage));
Check_Current(1U, 257U); Check_File(directory, "dtu", 1U, 257U);
assert(Upload(2U, 70000U, false));
assert(Example_Upgrade_Store_Authorize(&storage));
/* 授权是持久事实,普通 ABORT 不能再把它当作未完成上传删除。 */
assert(!Example_Upgrade_Store_Candidate_Abort(&storage));
Example_Upgrade_Store_Close(&storage);
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(Example_Upgrade_Store_Prepare_Boot(&storage));
assert(storage.core.status.state == IEC60870_FIRMWARE_UPDATE_TRIAL);
Check_Current(1U, 257U); Check_File(directory, "dtu", 2U, 70000U);
Check_File(directory, "dtu-1", 1U, 257U);
/* 没有健康确认便再启动,必须恢复旧 current,且不存在虚构的旧 backup。 */
Example_Upgrade_Store_Close(&storage);
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(Example_Upgrade_Store_Prepare_Boot(&storage));
Check_Current(1U, 257U); Check_File(directory, "dtu", 1U, 257U); Missing_File(directory, "dtu-1");
/* 两次真正确认后 dtu-1 只对应最近一次旧 current,不保留最初基线角色。 */
assert(Upgrade(2U, 70000U));
Check_Current(2U, 70000U); Check_File(directory, "dtu-1", 1U, 257U);
assert(Upgrade(3U, 513U));
Check_Current(3U, 513U); Check_File(directory, "dtu", 3U, 513U);
Check_File(directory, "dtu-1", 2U, 70000U);
Example_Upgrade_Store_Close(&storage);
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(Example_Upgrade_Store_Prepare_Boot(&storage));
assert(Example_Upgrade_Store_Confirm(&storage));
Check_Current(3U, 513U);
Example_Upgrade_Store_Close(&storage); Remove_Directory(directory);
}
/**
* 功能:验证以下场景与约束:完整成功路径先统计真实同步点,再逐点返回失败。
* 输入参数:parent——测试父目录(只读);baseline——已关闭的持久基线目录(只读)。
* 输出参数:无。
* 返回值:无。
* 说明:每个用例使用独立闭合基线。
* 返回失败后不重复业务,只关闭重开,由持久状态决定取消、继续安装或回退。
* 当前链路包含 23 个完成点,计数从实际运行获取;最后提交后的失败可能恢复新版,
* 其余阶段也可能恢复完整旧版。这里检查两种合法结果的全部安装字节及备份归属,
* 不模拟 Flush 内部扇区撕裂、缓存失电或目标程序健康运行。
*/
static void Test_Interruptions(const char *parent, const char *baseline)
{
char directory[MAX_PATH];
unsigned total, phase;
IEC60870_FirmwareUpdateDescriptor_t descriptor;
Copy_Directory(parent, baseline, directory);
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
observed = 0U; assert(Upgrade(2U, 513U)); total = observed;
assert(total >= 20U);
Example_Upgrade_Store_Close(&storage); Remove_Directory(directory);
for (phase = 1U; phase <= total; ++phase) {
Copy_Directory(parent, baseline, directory);
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
observed = 0U; interrupt_after = phase;
assert(!Upgrade(2U, 513U));
assert(observed == phase && storage.core.status.faulted);
assert(!Example_Upgrade_Store_Authorize(&storage));
Example_Upgrade_Store_Close(&storage); interrupt_after = 0U;
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(Example_Upgrade_Store_Prepare_Boot(&storage));
assert(Example_Upgrade_Store_Confirm(&storage));
assert(Example_Upgrade_Store_Current(&storage, &descriptor));
assert(descriptor.version == 1U || descriptor.version == 2U);
Check_File(directory, "dtu", descriptor.version, descriptor.size);
if (descriptor.version == 1U) { Missing_File(directory, "dtu-1"); }
else { Check_File(directory, "dtu-1", 1U, 257U); }
Example_Upgrade_Store_Close(&storage); Remove_Directory(directory);
}
printf("verified %u durable interruption points\n", total);
}
/**
* 功能:打开指定测试文件,供用例直接修改元数据或映像源槽。
* 输入参数:directory——测试目录路径(只读);name——测试文件名(只读)。
* 输出参数:无。
* 返回值:成功打开的独占文件句柄,由调用方负责关闭;打开失败由断言终止用例。
* 说明:正式后端关闭后才直接改元数据或源槽;独立的安装别名不由后端长期持有句柄。
*/
static HANDLE Raw(const char *directory, const char *name)
{
char path[MAX_PATH];
HANDLE file;
Path(directory, name, path);
file = CreateFileA(path, GENERIC_READ | GENERIC_WRITE, 0U, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
assert(file != INVALID_HANDLE_VALUE);
return file;
}
/**
* 功能:故障夹具按明确的格式偏移定位,不通过被测解析器反推损坏位置。
* 输入参数:file——已打开的测试文件句柄;offset——文件、记录或缓冲区偏移。
* 输出参数:无。
* 返回值:无。
* 说明:本辅助入口用于构造或核对上述测试场景,相关状态保存在当前测试夹具中。
*/
static void Seek_Raw(HANDLE file, uint32_t offset)
{
LARGE_INTEGER position;
position.QuadPart = offset;
assert(SetFilePointerEx(file, position, NULL, FILE_BEGIN));
}
/**
* 功能:读取完整元数据文件,供损坏注入前后逐字节比较。
* 输入参数:file——已打开的元数据句柄;bytes——快照缓冲区;length——预期文件长度及缓冲区容量。
* 输出参数:bytes——完整文件快照。
* 返回值:无。
* 说明:文件长度或读取长度不符立即终止用例;同时检查失败路径没有截断或扩展文件。
*/
static void Read_Metadata(HANDLE file, uint8_t *bytes, size_t length)
{
LARGE_INTEGER size;
DWORD done;
assert(GetFileSizeEx(file, &size) && size.QuadPart == (LONGLONG)length);
Seek_Raw(file, 0U);
assert(ReadFile(file, bytes, (DWORD)length, &done, NULL) && done == length);
}
/**
* 功能:确认失败恢复后元数据文件仍与损坏注入后的快照完全一致。
* 输入参数:directory——已关闭后端的测试目录;expected——包含文件头及两个完整 bank 的预期快照。
* 输出参数:无。
* 返回值:无。
* 说明:只读回原文件进行比对,不以 CRC 或 bank 选择结果代替全文件字节检查。
*/
static void Check_Metadata_Unchanged(const char *directory, const uint8_t *expected)
{
uint8_t bytes[216];
HANDLE file = Raw(directory, "upgrade.store");
Read_Metadata(file, bytes, sizeof(bytes));
assert(memcmp(bytes, expected, sizeof(bytes)) == 0);
assert(CloseHandle(file));
}
/**
* 功能:翻转真实文件字节并同步,验证实际恢复读取路径,而非只伪造回调失败。
* 输入参数:directory——测试目录路径(只读);name——测试文件名(只读);offset——文件、记录或缓冲区偏移。
* 输出参数:无。
* 返回值:无。
* 说明:本辅助入口用于构造或核对上述测试场景,相关状态保存在当前测试夹具中。
*/
static void Flip(const char *directory, const char *name, uint32_t offset)
{
HANDLE file = Raw(directory, name);
uint8_t byte;
DWORD done;
Seek_Raw(file, offset); assert(ReadFile(file, &byte, 1U, &done, NULL) && done == 1U);
byte ^= 0x55U; Seek_Raw(file, offset); Write_All(file, &byte, 1U);
assert(FlushFileBuffers(file)); assert(CloseHandle(file));
}
/**
* 功能:两个 bank 都通过各自 CRC 却使用相同代次、不同元数据时没有可靠先后关系。
* 输入参数:directory——测试目录路径(只读)。
* 输出参数:无。
* 返回值:无。
* 说明:修改旧代次后重算其头 CRC,特意保留两个不同且完整的核心载荷,避免误测普通 CRC 拒绝。
*/
static void Equal_Generation_Conflict(const char *directory)
{
uint8_t bytes[216];
HANDLE file = Raw(directory, "upgrade.store");
DWORD done;
uint32_t crc = UINT32_MAX;
size_t i;
unsigned bit;
assert(ReadFile(file, bytes, sizeof(bytes), &done, NULL) && done == sizeof(bytes));
memcpy(bytes + 32U + 92U + 8U, bytes + 32U + 8U, 8U);
for (i = 0U; i < 20U; ++i) {
crc ^= bytes[32U + 92U + i];
for (bit = 0U; bit < 8U; ++bit) {
crc = (crc >> 1) ^ ((crc & 1U) != 0U ? UINT32_C(0xedb88320) : 0U);
}
}
Put32(bytes + 32U + 92U + 20U, ~crc);
Seek_Raw(file, 0U); Write_All(file, bytes, sizeof(bytes));
assert(FlushFileBuffers(file)); assert(CloseHandle(file));
}
/**
* 功能:验证以下场景与约束:授权并不使候选变可靠:恢复时负载缺失、截断或 CRC 错都回到已验证的旧角色。
* 输入参数:parent——测试父目录(只读);baseline——已关闭的持久基线目录(只读)。
* 输出参数:无。
* 返回值:无。
* 说明:旧 current/backup 仍须完整,不能用坏候选取代它们或伪造一次确认。
*/
static void Test_Candidate_Recovery(const char *parent, const char *baseline)
{
unsigned mode;
for (mode = 0U; mode < 3U; ++mode) {
char directory[MAX_PATH], name[32], path[MAX_PATH];
HANDLE file;
Copy_Directory(parent, baseline, directory);
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(Upgrade(2U, 513U));
assert(Upload(3U, 777U, false));
assert(Example_Upgrade_Store_Authorize(&storage));
assert(snprintf(name, sizeof(name), "upgrade-slot%u.bin", (unsigned)storage.core.status.candidate_slot) > 0);
Example_Upgrade_Store_Close(&storage);
if (mode == 0U) {
Path(directory, name, path); assert(DeleteFileA(path));
} else if (mode == 1U) {
file = Raw(directory, name); Seek_Raw(file, 17U);
assert(SetEndOfFile(file)); assert(FlushFileBuffers(file)); assert(CloseHandle(file));
} else { Flip(directory, name, 1U); }
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(Example_Upgrade_Store_Prepare_Boot(&storage));
assert(storage.core.status.state == IEC60870_FIRMWARE_UPDATE_STABLE);
Check_Current(2U, 513U); Check_File(directory, "dtu", 2U, 513U);
Check_File(directory, "dtu-1", 1U, 257U);
Example_Upgrade_Store_Close(&storage); Remove_Directory(directory);
}
}
/**
* 功能:验证以下场景与约束:对真实安装文件做破坏,确认健康检查实际读它。
* 输入参数:parent——测试父目录(只读);baseline——已关闭的持久基线目录(只读)。
* 输出参数:无。
* 返回值:无。
* 说明:此 false 没有进入核心确认提交,
* 因而保留 TRIAL 及旧 current。下一次启动恢复原 current/backup 两份别名,
* 不把受损候选保留为正式备份。
*/
static void Test_Health(const char *parent, const char *baseline)
{
char directory[MAX_PATH];
Copy_Directory(parent, baseline, directory);
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(Upgrade(2U, 513U));
assert(Upload(3U, 777U, false));
assert(Example_Upgrade_Store_Authorize(&storage));
assert(Example_Upgrade_Store_Prepare_Boot(&storage));
Flip(directory, "dtu", 37U);
assert(!Example_Upgrade_Store_Confirm(&storage));
assert(storage.core.status.state == IEC60870_FIRMWARE_UPDATE_TRIAL);
Check_Current(2U, 513U);
Example_Upgrade_Store_Close(&storage);
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(Example_Upgrade_Store_Prepare_Boot(&storage));
Check_Current(2U, 513U); Check_File(directory, "dtu", 2U, 513U);
Check_File(directory, "dtu-1", 1U, 257U);
Example_Upgrade_Store_Close(&storage); Remove_Directory(directory);
}
/**
* 功能:验证文件头、任一元数据 bank 及源槽损坏均不能被忽略或静默重新初始化。
* 输入参数:parent——测试父目录(只读);baseline——已关闭的持久基线目录(只读)。
* 输出参数:无。
* 返回值:无。
* 说明:元数据损坏在 Open 阶段拒绝,不得恢复旧 TRIAL 后撤销已经成功确认的新版本。
* 源槽失败仍由 Prepare_Boot 发现;元数据拒绝路径不改写存储及安装别名。
*/
static void Test_Corruption(const char *parent, const char *baseline)
{
char directory[MAX_PATH];
HANDLE file;
unsigned bank;
Copy_Directory(parent, baseline, directory);
Flip(directory, "upgrade.store", 0U);
assert(!Example_Upgrade_Store_Open(&storage, directory, NULL));
Remove_Directory(directory);
for (bank = 0U; bank < 2U; ++bank) {
uint8_t damaged[216];
Copy_Directory(parent, baseline, directory);
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(Upgrade(2U, 513U)); Example_Upgrade_Store_Close(&storage);
/* 固定事务序列令 bank0 是最后确认、bank1 是此前 TRIAL。
* 最新或较旧 bank 损坏均须拒绝,不能退选 TRIAL 后安装旧版本。 */
Flip(directory, "upgrade.store", 32U + bank * 92U + 32U);
file = Raw(directory, "upgrade.store");
Read_Metadata(file, damaged, sizeof(damaged)); assert(CloseHandle(file));
observed = 0U;
assert(!Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(!Example_Upgrade_Store_Prepare_Boot(&storage));
assert(!Example_Upgrade_Store_Confirm(&storage));
assert(observed == 0U);
Check_Metadata_Unchanged(directory, damaged);
Check_File(directory, "dtu", 2U, 513U);
Check_File(directory, "dtu-1", 1U, 257U);
Missing_File(directory, "dtu.new"); Missing_File(directory, "dtu-1.new");
Example_Upgrade_Store_Close(&storage); Remove_Directory(directory);
}
Copy_Directory(parent, baseline, directory);
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(Upgrade(2U, 513U)); Example_Upgrade_Store_Close(&storage);
Equal_Generation_Conflict(directory);
assert(!Example_Upgrade_Store_Open(&storage, directory, NULL));
Remove_Directory(directory);
Copy_Directory(parent, baseline, directory);
file = Raw(directory, "upgrade.store");
/* 已有零长度档案是错误,不允许把它当首次创建重新写头。 */
Seek_Raw(file, 0U); assert(SetEndOfFile(file)); assert(FlushFileBuffers(file)); assert(CloseHandle(file));
assert(!Example_Upgrade_Store_Open(&storage, directory, NULL));
Remove_Directory(directory);
Copy_Directory(parent, baseline, directory);
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(Upgrade(2U, 513U)); Example_Upgrade_Store_Close(&storage);
Flip(directory, "upgrade.store", 32U + 32U);
Flip(directory, "upgrade.store", 32U + 92U + 32U);
assert(!Example_Upgrade_Store_Open(&storage, directory, NULL));
Remove_Directory(directory);
Copy_Directory(parent, baseline, directory);
/* 已确认源槽损坏必须阻止安装,原来正确的派生 dtu 仍保持原字节。 */
Flip(directory, "upgrade-slot0.bin", 1U);
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(!Example_Upgrade_Store_Prepare_Boot(&storage));
assert(storage.core.status.faulted);
Check_File(directory, "dtu", 1U, 257U);
Example_Upgrade_Store_Close(&storage); Remove_Directory(directory);
Copy_Directory(parent, baseline, directory);
file = Raw(directory, "upgrade-slot0.bin");
/* 正确前缀后多一字节仍须拒绝,覆盖实际长度检查而不只是 CRC 覆盖范围。 */
Seek_Raw(file, 257U); Write_All(file, (const uint8_t *)"x", 1U);
assert(FlushFileBuffers(file)); assert(CloseHandle(file));
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(!Example_Upgrade_Store_Prepare_Boot(&storage));
Example_Upgrade_Store_Close(&storage); Remove_Directory(directory);
}
/**
* 功能:验证已打开实例的直接元数据提交不会覆盖任一损坏 bank 或改写代次。
* 输入参数:parent——测试父目录;baseline——已关闭的持久基线目录。
* 输出参数:无。
* 返回值:无。
* 说明:通过实例拥有的文件句柄注入损坏,绕过重开检查单独覆盖提交回调;
* 两个 bank 分别损坏后,回调须在任何同步或安装之前失败,原文件字节保持不变。
*/
static void Test_Commit_Corruption(const char *parent, const char *baseline)
{
unsigned bank;
for (bank = 0U; bank < 2U; ++bank) {
char directory[MAX_PATH];
uint8_t damaged[216], actual[216], candidate[IEC60870_FIRMWARE_UPDATE_WIRE_SIZE];
HANDLE file;
Copy_Directory(parent, baseline, directory);
assert(Example_Upgrade_Store_Open(&storage, directory, NULL));
assert(Upgrade(2U, 513U));
memcpy(candidate, storage.core.wire, sizeof(candidate));
file = (HANDLE)storage.storage;
Read_Metadata(file, damaged, sizeof(damaged));
damaged[32U + bank * 92U + 32U] ^= 0x55U;
Seek_Raw(file, 0U); Write_All(file, damaged, sizeof(damaged));
assert(FlushFileBuffers(file));
observed = 0U;
assert(!storage.core.store.metadata_commit(storage.core.store.context, candidate, sizeof(candidate)));
assert(observed == 0U);
Read_Metadata(file, actual, sizeof(actual));
assert(memcmp(actual, damaged, sizeof(actual)) == 0);
Example_Upgrade_Store_Close(&storage);
Check_Metadata_Unchanged(directory, damaged);
Check_File(directory, "dtu", 2U, 513U);
Check_File(directory, "dtu-1", 1U, 257U);
Missing_File(directory, "dtu.new"); Missing_File(directory, "dtu-1.new");
Remove_Directory(directory);
}
}
/**
* 功能:入口只接受既有测试父目录。
* 输入参数:argc——命令行参数数量;argv——命令行参数数组。
* 输出参数:无。
* 返回值:正常完成返回 0;参数、运行或断言失败以非零状态结束进程。
* 说明:全部六组结束并关闭资源后,清理已知文件及基线。
*/
int main(int argc, char **argv)
{
char baseline[MAX_PATH];
assert(argc == 2);
Baseline(argv[1], baseline);
Test_Lifecycle(argv[1], baseline);
Test_Interruptions(argv[1], baseline);
Test_Health(argv[1], baseline);
Test_Candidate_Recovery(argv[1], baseline);
Test_Corruption(argv[1], baseline);
Test_Commit_Corruption(argv[1], baseline);
Remove_Directory(baseline);
puts("example upgrade host tests passed");
return 0;
}