开门见山,直奔主题吧
单元测试,又称单测,英文Unit Test,简称UT,目前已经算是现代软件开发的标配了,广泛存在于各种方向的编程项目中,学名叫”测试驱动开发“,英文简写为TDD,但是唯独在裸机固件的开发中还不是太被广泛应用,尤其是在国内,当然,可以理解,因为裸机程序的IAP甚至连单步调试都做不到,只能加log检查问题,一般来说代码量也较小,总体而言也不存在大规模regression test,很多公司图快就不怎么重视单测,不过以我个人的观点和经验来看,没有单测的项目,依然广泛存在一些后期才被发现出来的bug,单测的存在不仅简化了review的流程,也加强了开发的鲁棒性,让开发人员在修改代码时心里更有底
我自己手里是有一块stm32的开发板,现在拿来举例说一说裸机固件的单测应用
以Flash的读写为例,具体的代码我就不讲解了,直接贴代码了,有问题的朋友可以留言
写:
uint32_t Flash_Write_Data(uint32_t StartPageAddress, uint32_t *data, uint16_t size_of_data)
{
static FLASH_EraseInitTypeDef EraseInitStruct;
uint32_t PAGEError = 0;
int sofar = 0;
uint32_t EndAddress = StartPageAddress + size_of_data;
int page_start = GetPage(StartPageAddress);
int page_end = GetPage(EndAddress);
/* Unlock the Flash to enable the flash control register access *************/
HAL_FLASH_Unlock();
/* Fill EraseInit structure*/
EraseInitStruct.TypeErase = FLASH_TYPEERASE_PAGES;
EraseInitStruct.PageAddress = StartPageAddress;
EraseInitStruct.NbPages = page_end - page_start + 1;
if (HAL_FLASHEx_Erase(&EraseInitStruct, &PAGEError) != HAL_OK)
{
return HAL_FLASH_GetError();
}
/* Program the user Flash area 8 WORDS at a time
* (area defined by FLASH_USER_START_ADDR and FLASH_USER_END_ADDR) ***********/
uint32_t Address = StartPageAddress;
while (Address < EndAddress)
{
if (HAL_FLASH_Program(FLASH_TYPEPROGRAM_WORD, Address, data[sofar]) == HAL_OK)
{
Address = Address + 4;
sofar++;
} else {
return HAL_FLASH_GetError();
}
}
/* Lock the Flash to disable the flash control register access (recommended
to protect the FLASH memory against possible unwanted operation) *********/
HAL_FLASH_Lock();
return 0;
}
读:
void Flash_Read_Data(uint32_t StartPageAddress, uint32_t *data, uint16_t numberofwords)
{
while(1)
{
*data = *(__IO uint16_t*)StartPageAddress;
StartPageAddress += 4;
data++;
if(!(numberofwords--))
break;
}
}
初始化Flash
uint32_t Flash_init(uint32_t StartPageAddress, uint32_t numberofpages)
{
static FLASH_EraseInitTypeDef EraseInitStruct;
uint32_t PAGEError = 0;
/* Unlock the Flash to enable the flash control register access *************/
HAL_FLASH_Unlock();
/* Fill EraseInit structure*/
EraseInitStruct.TypeErase = FLASH_TYPEERASE_PAGES;
EraseInitStruct.PageAddress = StartPageAddress;
EraseInitStruct.NbPages = numberofpages;
if (HAL_FLASHEx_Erase(&EraseInitStruct, &PAGEError) != HAL_OK)
{
return HAL_FLASH_GetError();
}
HAL_FLASH_Lock();
return 0;
}
我在main函数里进行了单步调试,可以看到:
左侧的工具栏里已经可以看到被写的数组内容已经成功地被读数组读取了,也就是说被正确写入了flash的相应地址
c从左侧工具栏已经可以看出,在flash被init以后,读数组的内容已经是flash的相应地址被initialized以后的内容,即0X11111111,即每个bit都被置为1
好了,截至目前没发现什么问题对吧,不过GetPage函数是我自己实现的一个helper function,实际上这个函数的算法是有问题的,我也是从单测里才看出来的,好,咱们接下来说单测,现在嵌入式的测试也有人google test,我自己只在写业务逻辑,也就是不涉及交叉编译的情况下接触过g test,在嵌入式裸机程序领域,我只在很久以前用过unity和fff,unity和fff的作用分别对应google test和google mock,但是要轻,运行起来也更快,这两个都是开源框架,链接如下:
https://github.com/ThrowTheSwitch/Unity/
https://github.com/meekrosoft/fff
具体怎么配置我就不多说了,例程里都有
#include "unity.h"
#include "fff.h"
#include "stm32f0xx_hal_flash.h"
#include "stm32f0xx_hal_flash_ex.h"
#include "flash_sector_f0.h"
DEFINE_FFF_GLOBALS
FAKE_VALUE_FUNC2(HAL_StatusTypeDef, HAL_FLASHEx_Erase, FLASH_EraseInitTypeDef *, uint32_t *);
FAKE_VALUE_FUNC0(HAL_StatusTypeDef, HAL_FLASH_Unlock);
FAKE_VALUE_FUNC0(uint32_t, HAL_FLASH_GetError);
FAKE_VALUE_FUNC0(HAL_StatusTypeDef, HAL_FLASH_Lock);
FAKE_VALUE_FUNC3(HAL_StatusTypeDef, HAL_FLASH_Program, uint32_t, uint32_t, uint64_t);
void setUp(void)
{
/* This is run before EACH TEST */
FFF_RESET_HISTORY();
}
void tearDown(void)
{
}
void test_case1(void)
{
TEST_ASSERT_EQUAL(GetPage(0x08000001), 0);
TEST_ASSERT_EQUAL(GetPage(0x080003FF), 0);
}
void test_case3(void)
{
TEST_ASSERT_EQUAL(GetPage(0x08000400), 1);
TEST_ASSERT_EQUAL(GetPage(0x080007FF), 1);
}
void test_case2(void)
{
uint32_t data_write[] = {};
Flash_Write_Data(0x08000000, data_write, 4);
TEST_ASSERT_EQUAL(HAL_FLASH_Lock_fake.call_count, 1);
TEST_ASSERT_EQUAL(HAL_FLASH_Unlock_fake.call_count, 1);
}
int main(int argc, const char * argv[])
{
RUN_TEST(test_case1);
RUN_TEST(test_case2);
RUN_TEST(test_case3);
}
运行结果:
可以看到,测试用例3没有通过,在这里我发现了我一个位于GetPage函数里的低级算法问题,具体是啥问题就不说了,我的意思只是说,这种问题通过单步调试去找很麻烦,单测可以快速排查
目前还在研究如果在VS Code里直接跑CTest插件,目前还没研究出来,等搞明白了再来补充