libc-test is developed as part of the musl project
http://www.musl-libc.org/

configuring:
	cp config.mak.def config.mak
	edit config.mak
build and run tests:
	make
clean up:
	make clean

make builds all test binaries and runs them to create
a REPORT file that contains all build and runtime errors
(this means that make does not stop at build failures)

contributing tests:

design goals:

- tests should be easy to run and build even a single test in isolation
(so test should be self contained if possible)
- failure of one test should not interfere with others
(build failure, crash or unexpected results are all failures)
- test output should point to the cause of the failure
- test results should be robust
- the test system should have minimal dependency
(libc, posix sh, gnu make)
- the test system should run on all archs and libcs
- tests should leave the system in a clean state

conventions:

each test is in a separate file at a path like src/directory/file.c with
its own main

the test should return 0 on success and non-0 on failure, on failure it
should print error messages to standard out if possible, on success no
message should be printed

to help with the above test protocol use t_error function for printing
errors and return t_status from main, see src/common/test.h
(t_error allows standard printf formatting, outputs at most 512bytes
in a single write call to fd 1, so there is no buffering, long outputs
are truncated, it sets the global t_status to 1)

it is common to do many similar checks in a test, in such cases macros
may be used to simplify the code like
#define T1(a,b) (check(a,b) || (t_error("check(%s,%s) failed\n", a, b),0))
#define T2(f,w) (result=(f), result==(w) || (t_error("%s failed: got %s, want %s\n", #f, result, w),0))

binaries should be possible to run from arbitrary directory.
the build system runs the tests using the src/common/runtest tool which
kills the test process after a timeout and reports the exit status
in case of failure

directories:

src/api: interface tests, build time include header tests
src/common: common utilities compiled into libtest.a
src/functional: functional tests aiming for large coverage of libc
src/math: tests for each math function with input-output test vectors
src/regression: regression tests aiming for testing particular bugs

initial set of functional tests are derived from the libc-testsuit of
Rich Felker, regression tests should contain reference of the bug
(musl commit hash, glibc bug tracker url, etc)

build system:

the main non-file make targets are all, run, clean and cleanall.
(cleanall removes the reports unlike clean, run reruns the dynamically
linked executables)

make variable can be overridden from config.mak or the make command line,
the variable B sets the build directory which is src by default

for each directory under src there are targets like $(B)/directory/all,
$(B)/directory/run and $(B)/directory/clean to make only the contents
of that directory, each directory has its own Makefile set up so it
invokes the top level make with B=src src/directory/foo for the foo
target, so it is possible to work only under a specific test directory

the build and runtime errors of each target are accumulated into a
target.err file and in the end they are concatenated into a REPORT

each .c file in src/functional and src/regression are built into a
dynamic linked and a static linked executable test binary by default,
this behaviour can be changed by a similarly named .mk file changing
make variables and specifying additional rules:

$(B)/$(N) is the name of the binary target (the file name without the .c)
$(B)/$(N)-static is the name of the static binary target
$(B)/$(D) is the build directory
$(N).CFLAGS are added to the CFLAGS at compilation
$(N).LDFLAGS are added to the LDFLAGS at linking
$(N).LDLIBS are added to the LDLIBS at linking
$(N).BINS are the targets (if empty no binaries are built)
$(N).LIBS are the non-executable targets (shared objects may use it)

if a binary is linked together from several .o files then they
have to be specified as prerequisits for the binary targets and
added to the $(N).LDLIBS as well

if a binary depends on a file at runtime (eg. a .so opened by dlopen)
then the $(N).err target should depend on that file

## libc-test脚本使用说明

### 一、生成用例

编译命令，单独编译出libc-test测试用例

```shell
./build.sh --product-name Hi3516DV300 --build-target third_party/musl:libctest
```

文件生成的目录位于  `out/hi3516dv300/tests/unittest/libc-test`

注：

旧版ohos中，文件生成的目录位于  `out/ohos-arm-release/tests/unittest/libc-test`，请根据实际修改脚本中相关路径！！

请务必根据实际修改脚本中相关路径！

### 二、执行用例

1. 将HDC(Windows版)工具加入到windows环境变量,并将工具改名为hdc.exe。连接上开发板，保证HDC工具可以连接。

2. 进入musl/scripts，并根据实际环境，修改runtest.bat中测试用例生成目录完整路径（必要）

   ```bat
   @REM 本地OpenHarmony源码目录,请根据实际环境修改！！
   set LOCAL=\\wsl$\ubuntu-20.04\home\OHOS\
   @REM 本地编译out目录
   set OUTDIR=out\hi3516dv300
   ```

3. 将bat脚本复制到windows环境下使用！！windows端双击运行runtest.bat，执行完毕会将结果REPORT返回到当前bat所在目录。

   此bat将从WSL映射目录传输文件到单板目录下，由于WSL无法直接访问windows端口，所以在WSL中直接使用可能无法传输用例。

4. 若要单独执行测试用例，需要先将common目录下的`runtest`与用例传输到单板，再通过命令执行，结果将打印出来

   ```shell
   ./runtest -w '' {filename}
   ```
5. runtest.bat执行结束前会将输出的REPORT与在libc-test/report_base下的REPORT相比较，如果比较出不同将会在scripts下
   生成一个result.html文件，否则不生成。


### 三、增加用例

若要在functional、math、regression或增加用例，需要在相应目录的test_src_{dir}.gni中添加文件名。

例如：

1、需要在functional目录中新增一个用例：由`new_test.c`生成可执行文件`new_test`

2、首先把c文件放入functional目录中，打开`test_src_functional.gni`，在`functional_list`中最后一行增加`"new_test",`

3、执行步骤一（生成用例）中的编译命令，即可生成对应可执行文件。