1# RT-Thread 测试用例集合
2
3## 简介
4
5为了保证某一部分代码的质量，通常可以通过编写测试用例的方式，验证此代码的功能。为了保证 RT-Thread 相关仓库的代码质量，我们基于 utest 框架搭建了一套简易的自动化测试环境。有兴趣，有精力的小伙伴可以利用这套机制完善自己的代码检查。如果有意愿让社区上更多的小伙伴受益，也可以在提交代码的时候，把对应的测试用例也提交上来。
6
7## 目录结构
8
9| 目录      | 用途                                                         |
10| --------- | ------------------------------------------------------------ |
11| configs   | 配置文件集合（每一个目录代表一种功能集合，如：kernel,net等） |
12| testcases | 测试用例源代码                                               |
13
14## 如何贡献
15
16### 1. 编写测试用例
17
18参考已有的测试用例在 [examples\utest\testcases](./testcases) 目录下添加自己的测试用例。测试用例的编写方法参考文档中心[《utest 测试框架》章节](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/programming-manual/utest/utest)。
19
20### 2. 本地测试
21
221. 在 `bsp\qemu-vexpress-a9` 目录下打开 `menuconfig`，使能对应的测试用例，如下：
23
24```
25RT-Thread Utestcases  --->
26  [*] RT-Thread Utestcases
27        Utest Self Testcase  --->
28          [*] Pass test
29```
30
312. 保存并退出，输入 scons 编译当前 bsp。
32
333. 输入 .\qemu.bat 运行当前 bsp，在 msh 环境下执行 utest_run 命令，验证代码运行是否正常。
34
35```
36msh />utest_run
37[I/utest] [==========] [ utest    ] loop 1/1
38[I/utest] [==========] [ utest    ] started
39[I/utest] [----------] [ testcase ] (testcases.utest.pass_tc) started
40[D/utest] [    OK    ] [ unit     ] (test_assert_pass:16) is passed
41[D/utest] [    OK    ] [ unit     ] (test_assert_pass:17) is passed
42[D/utest] [    OK    ] [ unit     ] (test_assert_pass:19) is passed
43[D/utest] [    OK    ] [ unit     ] (test_assert_pass:20) is passed
44[D/utest] [    OK    ] [ unit     ] (test_assert_pass:22) is passed
45[D/utest] [    OK    ] [ unit     ] (test_assert_pass:23) is passed
46[D/utest] [    OK    ] [ unit     ] (test_assert_pass:25) is passed
47[D/utest] [    OK    ] [ unit     ] (test_assert_pass:26) is passed
48[D/utest] [    OK    ] [ unit     ] (test_assert_pass:28) is passed
49[D/utest] [    OK    ] [ unit     ] (test_assert_pass:29) is passed
50[I/utest] [  PASSED  ] [ result   ] testcase (testcases.utest.pass_tc)
51[I/utest] [----------] [ testcase ] (testcases.utest.pass_tc) finished
52[I/utest] [==========] [ utest    ] finished
53```
54
55### 3. 提交
56
571. 如果是对已有测试集合的完善，需要把添加的测试用例的配置项，以及对应的依赖项添加到对应测试集合的配置文件里，如：[examples\utest\configs\kernel\mem.conf](./configs/kernel/mem.conf)。
58
59```
60CONFIG_UTEST_MEMHEAP_TC=y
61
62# dependencies
63CONFIG_RT_USING_MEMHEAP=y
64```
65
662. 如果要添加新的测试集合，需要参考已有的测试集合，在 [examples\utest\configs](./configs) 目录下添加新的测试集合配置项。并更新 [.github\workflows\action_utest.yml](../../.github/workflows/action_utest.yml) 内的测试集合。
67
68```
69- {UTEST: "kernel/mem",       RTT_BSP: "bsp/qemu-vexpress-a9",   QEMU_ARCH: "arm", QEMU_MACHINE: "vexpress-a9", CONFIG_FILE: "kernel/mem.conf", SD_FILE: "sd.bin"}
70- {UTEST: "components/utest", RTT_BSP: "bsp/qemu-vexpress-a9",   QEMU_ARCH: "arm", QEMU_MACHINE: "vexpress-a9", CONFIG_FILE: "utest_self/self.conf", SD_FILE: "sd.bin"}
71```
72
733. 向 RT-Thread 主仓库提交合并请求。
74