doc: kTEST自动测试文档

This commit is contained in:
fslongjin 2022-07-29 19:04:05 +08:00
parent 7c9366b297
commit fd55328dfc
3 changed files with 135 additions and 0 deletions

View File

@ -24,6 +24,7 @@
kernel/memory_management/index
kernel/filesystem/index
kernel/debug/index
kernel/ktest/index
kernel/cpu_arch/index

View File

@ -0,0 +1,20 @@
====================================
内核测试
====================================
本章节将介绍如何测试内核,包括手动测试以及自动测试。
我们需要尽可能的对内核进行完善的测试以便我们能够更好的保证内核的稳定性且减少其他模块的debug难度。
设置完善的测试用例能帮助我们尽可能的检测到问题防止我们在写新的模块的时候被已有的模块的一些藏得很深的bug“背刺一刀”。
由于您难以借助GDB等工具进行调试因此在内核中进行手动测试比应用程序测试要困难一些。
对于一些模块,我们可以使用编写代码进行单元测试,并输出异常信息。遗憾的是,并非所有模块都可以进行单元测试。比如我们常见的内存管理、进程管理等模块都不能进行单元测试。
.. toctree::
:maxdepth: 1
:caption: 目录
ktest-framework

View File

@ -0,0 +1,114 @@
# 内核测试框架
  DragonOS提供了一个测试框架旨在对内核的一些模块进行自动化测试。内核测试框架位于`ktest/`下。
  我们可以使用这个测试框架,按照规范编写测试代码,然后在合适的地方使用`ktest_start()`创建一个全新的内核线程并发起测试。
## 使用方法
### 创建自动测试程序
  假如您要对kfifo模块进行自动测试您可以在`ktest/`下,创建一个名为`test-kfifo.c`的测试文件并编写Makefile。
  `test-kfifo.c`中,包含`ktest_utils.h``ktest.h`这两个头文件。
  您需要像下面这样,在`test-kfifo.c`中,创建一个测试用例函数表,并把测试用例函数填写到其中:
```c
static ktest_case_table kt_kfifo_func_table[] = {
ktest_kfifo_case0_1,
};
```
  然后创建一个函数作为kfifo测试的主函数。请注意您需要将它的声明添加到`ktest.h`中。
```c
uint64_t ktest_test_kfifo(uint64_t arg)
{
kTEST("Testing kfifo...");
for (int i = 0; i < sizeof(kt_kfifo_func_table) / sizeof(ktest_case_table); ++i)
{
kTEST("Testing case %d", i);
kt_kfifo_func_table[i](i, 0);
}
kTEST("kfifo Test done.");
return 0;
}
```
### 编写测试用例
&emsp;&emsp;您可以创建一个或多个测试用例,命名为:`ktest_kfifo_case_xxxxx`. 在这个例子中,我创建了一个测试用例,命名为:`ktest_kfifo_case0_1`.如下所示:
```c
static long ktest_kfifo_case0_1(uint64_t arg0, uint64_t arg1)
```
&emsp;&emsp;这里最多允许我们传递两个参数到测试函数里面。
&emsp;&emsp;那么,我们该如何编写测试用例呢?
&emsp;&emsp;我们主要是需要设置一些情节,以便能测试到目标组件的每个情况。为了检验模块的行为是否符合预期,我们需要使用`assert(condition)`宏函数,对目标`condition`进行校验。若`condition`为1则表明测试通过。否则将会输出一行assert failed信息到屏幕上。
### 发起测试
&emsp;&emsp;我们可以在pid≥1的内核线程中发起测试。由于DragonOS目前尚不完善您可以在`process/process.c`中的`initial_kernel_thread()`函数内,发起内核自动测试。具体的代码如下:
```c
ktest_start(ktest_test_kfifo, 0);
```
&emsp;&emsp;这样就发起了一个内核测试,它会创建一个新的内核线程进行自动测试,您不必担心第一个内核线程会被阻塞。
&emsp;&emsp;
## API文档
### ktest_start
`pid_t ktest_start(uint64_t (*func)(uint64_t arg), uint64_t arg)`
#### 描述
&emsp;&emsp;开启一个新的内核线程以进行测试
#### 参数
**func**
&emsp;&emsp;测试函数. 新的测试线程将会执行该函数,以进行测试。
**arg**
&emsp;&emsp;传递给测试函数的参数
#### 返回值
&emsp;&emsp;测试线程的pid
### assert
`#define assert(condition)`
#### 描述
&emsp;&emsp;判定condition是否为1若不为1则输出一行错误日志信息
```
[ kTEST FAILED ] Ktest Assertion Failed, file:%s, Line:%d
```
### kTEST
```#define kTEST(...) ```
#### 描述
&emsp;&emsp;格式化输出一行以`[ kTEST ] file:%s, Line:%d`开头的日志信息。
### ktest_case_table
`typedef long (*ktest_case_table)(uint64_t arg0, uint64_t arg1)`
#### 描述
&emsp;&emsp;ktest用例函数的类型定义。