练习30：自动化测试

原文：Exercise 30: Automated Testing

译者：飞龙

自动化测试经常用于例如Python和Ruby的其它语言，但是很少用于C。一部分原因是自动化加载和测试C的代码片段具有较高的难度。这一章中，我们会创建一个非常小型的测试“框架”，并且使用你的框架目录构建测试用例的示例。

我接下来打算使用，并且你会包含进框架目录的框架，叫做“minunit”，它以Jera Design所编写的一小段代码作为开始，之后我扩展了它，就像这样：

  1. #undef NDEBUG
  2. #ifndef _minunit_h
  3. #define _minunit_h
  5. #include <stdio.h>
  6. #include <dbg.h>
  7. #include <stdlib.h>
  9. #define mu_suite_start() char *message = NULL
  11. #define mu_assert(test, message) if (!(test)) { log_err(message); return message; }
  12. #define mu_run_test(test) debug("\n-----%s", " " #test); \
  13.     message = test(); tests_run++; if (message) return message;
  15. #define RUN_TESTS(name) int main(int argc, char *argv[]) {\
  16.     argc = 1; \
  17.     debug("----- RUNNING: %s", argv[0]);\
  18.         printf("----\nRUNNING: %s\n", argv[0]);\
  19.         char *result = name();\
  20.         if (result != 0) {\
  21.             printf("FAILED: %s\n", result);\
  22.         }\
  23.         else {\
  24.             printf("ALL TESTS PASSED\n");\
  25.         }\
  26.     printf("Tests run: %d\n", tests_run);\
  27.         exit(result != 0);\
  28. }
  31. int tests_run;
  33. #endif

原始的内容所剩不多了，现在我使用dbg.h宏，并且在模板测试运行器的末尾创建了大量的宏。在这小段代码中我们创建了整套函数单元测试系统，一旦它结合上shell脚本来运行测试，你可以将其用于你的C代码。

完成测试框架

为了基础这个练习，你应该让你的src/libex29.c正常工作，并且完成练习29的附加题，是ex29.c加载程序并合理运行。练习29中我这事了一个附加题来使它像单元测试一样工作，但是现在我打算重新想你展示如何使用minunit.h来做这件事。

首先我们需要创建一个简单的空单元测试，命名为tests/libex29_tests.c，在里面输入：

  1. #include "minunit.h"
  3. char *test_dlopen()
  4. {
  6.     return NULL;
  7. }
  9. char *test_functions()
  10. {
  12.     return NULL;
  13. }
  15. char *test_failures()
  16. {
  18.     return NULL;
  19. }
  21. char *test_dlclose()
  22. {
  24.     return NULL;
  25. }
  27. char *all_tests() {
  28.     mu_suite_start();
  30.     mu_run_test(test_dlopen);
  31.     mu_run_test(test_functions);
  32.     mu_run_test(test_failures);
  33.     mu_run_test(test_dlclose);
  35.     return NULL;
  36. }
  38. RUN_TESTS(all_tests);

这份代码展示了tests/minunit.h中的RUN_TESTS宏，以及如何使用其他的测试运行器宏。我没有编写实际的测试函数，所以你只能看到单元测试的结构。我首先会分解这个文件：

libex29_tests.c:1

包含minunit.h框架。

libex29_tests.c:3-7

第一个测试。测试函数具有固定的结构，它们不带任何参数并且返回char *，成功时为NULL。这非常重要，因为其他宏用于向测试运行器返回错误信息。

libex29_tests.c:9-25

与第一个测试相似的更多测试。

libex29_tests.c:27

控制其他测试的运行器函数。它和其它测试用例格式一致，但是使用额外的东西来配置。

libex29_tests.c:28

为mu_suite_start测试设置一些通用的东西。

libex29_tests.c:30

这就是使用mu_run_test返回结果的地方。

libex29_tests.c:35

在你运行所有测试之后，你应该返回NULL，就像普通的测试函数一样。

libex29_tests.c:38

最后需要使用RUN_TESTS宏来启动main函数，让它运行all_tests启动器。

这就是用于运行测试所有代码了，现在你需要尝试使它运行在项目框架中。下面是我的执行结果：

  1. not printable

我首先执行make clean，之后我运行了构建，它将模板改造为libYOUR_LIBRARY.a和libYOUR_LIBRARY.so文件。要记住你需要在练习29的附加题中完成它。但如果你没有完成的话，下面是我所使用的Makefile的文件差异：

  1. diff --git a/code/c-skeleton/Makefile b/code/c-skeleton/Makefile
  2. index 135d538..21b92bf 100644
  3. --- a/code/c-skeleton/Makefile
  4. +++ b/code/c-skeleton/Makefile
  5. @@ -9,9 +9,10 @@ TEST_SRC=$(wildcard tests/*_tests.c)
  6.  TESTS=$(patsubst %.c,%,$(TEST_SRC))
  8.  TARGET=build/libYOUR_LIBRARY.a
  9. +SO_TARGET=$(patsubst %.a,%.so,$(TARGET))
  11.  # The Target Build
  12. -all: $(TARGET) tests
  13. +all: $(TARGET) $(SO_TARGET) tests
  15.  dev: CFLAGS=-g -Wall -Isrc -Wall -Wextra $(OPTFLAGS)
  16.  dev: all
  17. @@ -21,6 +22,9 @@ $(TARGET): build $(OBJECTS)
  18.          ar rcs $@ $(OBJECTS)
  19.          ranlib $@
  21. +$(SO_TARGET): $(TARGET) $(OBJECTS)
  22. +       $(CC) -shared -o $@ $(OBJECTS)
  23. +
  24.  build:
  25.          @mkdir -p build
  26.          @mkdir -p bin

完成这些改变后，你现在应该能够构建任何东西，并且你可以最后补完剩余的单元测试函数：

  1. #include "minunit.h"
  2. #include <dlfcn.h>
  4. typedef int (*lib_function)(const char *data);
  5. char *lib_file = "build/libYOUR_LIBRARY.so";
  6. void *lib = NULL;
  8. int check_function(const char *func_to_run, const char *data, int expected)
  9. {
  10.     lib_function func = dlsym(lib, func_to_run);
  11.     check(func != NULL, "Did not find %s function in the library %s: %s", func_to_run, lib_file, dlerror());
  13.     int rc = func(data);
  14.     check(rc == expected, "Function %s return %d for data: %s", func_to_run, rc, data);
  16.     return 1;
  17. error:
  18.     return 0;
  19. }
  21. char *test_dlopen()
  22. {
  23.     lib = dlopen(lib_file, RTLD_NOW);
  24.     mu_assert(lib != NULL, "Failed to open the library to test.");
  26.     return NULL;
  27. }
  29. char *test_functions()
  30. {
  31.     mu_assert(check_function("print_a_message", "Hello", 0), "print_a_message failed.");
  32.     mu_assert(check_function("uppercase", "Hello", 0), "uppercase failed.");
  33.     mu_assert(check_function("lowercase", "Hello", 0), "lowercase failed.");
  35.     return NULL;
  36. }
  38. char *test_failures()
  39. {
  40.     mu_assert(check_function("fail_on_purpose", "Hello", 1), "fail_on_purpose should fail.");
  42.     return NULL;
  43. }
  45. char *test_dlclose()
  46. {
  47.     int rc = dlclose(lib);
  48.     mu_assert(rc == 0, "Failed to close lib.");
  50.     return NULL;
  51. }
  53. char *all_tests() {
  54.     mu_suite_start();
  56.     mu_run_test(test_dlopen);
  57.     mu_run_test(test_functions);
  58.     mu_run_test(test_failures);
  59.     mu_run_test(test_dlclose);
  61.     return NULL;
  62. }
  64. RUN_TESTS(all_tests);

我希望你可以弄清楚它都干了什么，因为这里没有什么新的东西，除了check_function函数。这是一个通用的模式，其中我需要重复执行一段代码，然后通过为之创建宏或函数来使它自动化。这里我打算运行.so中所加载的函数，所以我创建了一个小型函数来完成它。

附加题

  • 这段代码能起作用，但是可能有点乱。清理框架目录，是它包含所有这些文件，但是移除任何和练习29有关的代码。你应该能够复制这个目录并且无需很多编辑操作就能开始新的项目。
  • 研究runtests.sh，并且查询有关bash语法的资料，来弄懂它的作用。你能够编写这个脚本的C版本吗？