Custom Built-in Unit Test Suite (#105)

* tests: new built-in test runner

* tests: update tests for new builtin test api

* tests: print test suite logs

* tests: remove cmocka from build files

* tests: colorize test suite log and remove redundant prints

Author: recp

.github/workflows/ccpp.yml

@@ -51,7 +51,6 @@ cscope.*
 test/*.trs
 test/test_*
 *.log
-test-*
 test/.libs/*
 test/tests
 cglm_arm/*
@@ -71,3 +70,4 @@ win/x85
 win/Debug
 cglm-test-ios*
 /cglm.pc
+test-driver

.gitignore

@@ -7,7 +7,6 @@
 #******************************************************************************
 
 ACLOCAL_AMFLAGS = -I m4
-
 AM_CFLAGS = -Wall \
             -std=gnu99 \
             -O3 \
@@ -19,12 +18,9 @@ lib_LTLIBRARIES = libcglm.la
 libcglm_la_LDFLAGS = -no-undefined -version-info 0:1:0
 
 checkLDFLAGS = -L./.libs \
-               -L./test/lib/cmocka/build/src \
-               -lcmocka \
                -lm \
                -lcglm
-checkCFLAGS = -I./test/lib/cmocka/include \
-              -I./include
+checkCFLAGS = -I./include
 
 check_PROGRAMS = test/tests
 TESTS = $(check_PROGRAMS)
@@ -140,8 +136,8 @@ libcglm_la_SOURCES=\
     src/bezier.c
 
 test_tests_SOURCES=\
+    test/runner.c \
     test/src/test_common.c \
-    test/src/test_main.c \
     test/src/test_mat4.c \
     test/src/test_cam.c \
     test/src/test_project.c \
@@ -160,7 +156,7 @@ pkgconfig_DATA=cglm.pc
 # the source directory that post-build.sh is in. When not
 # using a prefix, $VPATH will be unset, so we need to fall
 # back to using . to run the script.
-export VPATH
+#export VPATH
 
-all-local:
-	sh $${VPATH:-.}/post-build.sh
+# all-local:
+#	sh $${VPATH:-.}/post-build.sh

Makefile.am

@@ -8,7 +8,7 @@
 
 AC_PREREQ([2.69])
 AC_INIT([cglm], [0.6.0], [[email protected]])
-AM_INIT_AUTOMAKE([-Wall -Werror foreign subdir-objects])
+AM_INIT_AUTOMAKE([-Wall -Werror foreign subdir-objects serial-tests])
 
 AC_CONFIG_MACRO_DIR([m4])
 AC_CONFIG_SRCDIR([src/])

configure.ac

@@ -0,0 +1,81 @@
+/*
+ * Copyright (c), Recep Aslantas.
+ *
+ * MIT License (MIT), http://opensource.org/licenses/MIT
+ * Full license can be found in the LICENSE file
+ */
+
+#ifndef tests_common_h
+#define tests_common_h
+
+#include <stdlib.h>
+#include <stdio.h>
+
+#include <cglm/cglm.h>
+#include <cglm/struct.h>
+#include <cglm/call.h>
+
+typedef struct test_status_t {
+  const char *msg;
+  int         status;
+} test_status_t;
+
+typedef test_status_t (*fntest)(void);
+
+typedef struct test_entry_t {
+  char  *name;
+  fntest entry;
+  int    ret;
+  int    show_output;
+} test_entry_t;
+
+#define RESET       "\033[0m"
+#define BLACK       "\033[30m"             /* Black */
+#define RED         "\033[31m"             /* Red */
+#define GREEN       "\033[32m"             /* Green */
+#define YELLOW      "\033[33m"             /* Yellow */
+#define BLUE        "\033[34m"             /* Blue */
+#define MAGENTA     "\033[35m"             /* Magenta */
+#define CYAN        "\033[36m"             /* Cyan */
+#define WHITE       "\033[37m"             /* White */
+#define BOLDBLACK   "\033[1m\033[30m"      /* Bold Black */
+#define BOLDRED     "\033[1m\033[31m"      /* Bold Red */
+#define BOLDGREEN   "\033[1m\033[32m"      /* Bold Green */
+#define BOLDYELLOW  "\033[1m\033[33m"      /* Bold Yellow */
+#define BOLDBLUE    "\033[1m\033[34m"      /* Bold Blue */
+#define BOLDMAGENTA "\033[1m\033[35m"      /* Bold Magenta */
+#define BOLDCYAN    "\033[1m\033[36m"      /* Bold Cyan */
+#define BOLDWHITE   "\033[1m\033[37m"      /* Bold White */
+
+#define TEST_DECLARE(FUN) test_status_t test_ ## FUN(void);
+#define TEST_ENTRY(FUN)   { #FUN, test_ ## FUN, 0, 0 },
+#define TEST_LIST         static test_entry_t tests[] = 
+
+#define ASSERT_EXT(expr, msg)                                                 \
+  if (!(expr)) {                                                              \
+    fprintf(stderr,                                                           \
+            RED "  assert fail" RESET                                         \
+            " in " BOLDCYAN "%s " RESET                                       \
+            "on " BOLDMAGENTA "line %d" RESET                                 \
+            " : " BOLDWHITE " ASSERT(%s)\n" RESET,                            \
+            __FILE__,                                                         \
+            __LINE__,                                                         \
+            #expr);                                                           \
+    return (test_status_t){msg, 0};                                           \
+  }
+
+#define ASSERT_ARG1(expr)                  ASSERT_EXT(expr, NULL)
+#define ASSERT_ARG2(expr, msg)             ASSERT_EXT(expr, msg)
+#define ASSERT_ARG3(arg1, arg2, arg3, ...) arg3
+
+#define ASSERT_CHOOSER(...) ASSERT_ARG3(__VA_ARGS__, ASSERT_ARG2, ASSERT_ARG1)
+#define ASSERT(...) do { ASSERT_CHOOSER(__VA_ARGS__)(__VA_ARGS__) } while(0);
+
+#define TEST_OK 1
+#define TEST_SUCCESS  return (test_status_t){NULL, TEST_OK};
+
+#define TEST_IMPL(FUN)                                                        \
+  test_status_t test_ ## FUN (void);                                          \
+  test_status_t test_ ## FUN()
+
+#endif /* common_h */

post-build.sh

@@ -0,0 +1,68 @@
+/*
+ * Copyright (c), Recep Aslantas.
+ *
+ * MIT License (MIT), http://opensource.org/licenses/MIT
+ * Full license can be found in the LICENSE file
+ */
+
+#include "include/common.h"
+#include "tests.h"
+
+#include <stdlib.h>
+
+int
+main(int argc, const char * argv[]) {
+  test_entry_t *entry;
+  test_status_t st;
+  int32_t       i, count, passed, failed;
+
+  passed = failed = 0;
+  count  = sizeof(tests) / sizeof(tests[0]);
+ 
+  fprintf(stderr, CYAN "\nWelcome to cglm tests\n\n" RESET);
+  
+  for (i = 0; i < count; i++) {
+    entry = tests + i;
+    st    = entry->entry();
+
+    if (!st.status) {
+      fprintf(stderr,
+              BOLDRED  "  𐄂" BOLDWHITE " %s " RESET,
+              entry->name);
+      if (st.msg) {
+        fprintf(stderr,
+                YELLOW "- %s" RESET,
+                st.msg);
+      }
+
+      fprintf(stderr, "\n");
+
+      failed++;
+    } else {
+      fprintf(stderr,
+              GREEN  "  ✔︎" RESET " %s\n"
+              ,
+              entry->name);
+      passed++;
+    }
+  }
+  
+  if (failed == 0) {
+    fprintf(stderr, BOLDGREEN "\n  All tests are passed 🎉\n" RESET);
+  }
+
+  fprintf(stderr,
+          CYAN "\ncglm test results:\n" RESET
+          "------------------\n"
+          
+          MAGENTA "%d" RESET " tests are runned, "
+          GREEN   "%d" RESET " %s passed, "
+          RED     "%d" RESET " %s failed\n\n" RESET,
+          passed + failed,
+          passed,
+          passed > 1 ? "are" : "is",
+          failed,
+          failed > 1 ? "are" : "is");
+
+  return failed;
+}

test/include/common.h

@@ -7,8 +7,7 @@
 
 #include "test_common.h"
 
-void
-test_affine(void **state) {
+TEST_IMPL(affine) {
   mat4 t1, t2, t3, t4, t5;
 
   /* test translate is postmultiplied */
@@ -18,7 +17,7 @@ test_affine(void **state) {
   glmc_mat4_mul(t1, t2, t3); /* R * T */
 
   glm_translate(t1, (vec3){34, 57, 36});
-  test_assert_mat4_eq(t1, t3);
+  ASSERT(test_assert_mat4_eq(t1, t3).status == 1)
 
   /* test rotate is postmultiplied */
   glmc_rotate_make(t1, GLM_PI_4f, GLM_YUP);
@@ -27,7 +26,7 @@ test_affine(void **state) {
   glmc_mat4_mul(t2, t1, t3); /* T * R */
 
   glm_rotate(t2, GLM_PI_4f, GLM_YUP);
-  test_assert_mat4_eq(t2, t3);
+  ASSERT(test_assert_mat4_eq(t2, t3).status == 1)
 
   /* test scale is postmultiplied */
   glmc_rotate_make(t1, GLM_PI_4f, GLM_YUP);
@@ -38,31 +37,31 @@ test_affine(void **state) {
   glmc_mat4_mul(t3, t4, t5); /* T * R * S */
 
   glm_scale(t3, (vec3){3, 5, 6});
-  test_assert_mat4_eq(t3, t5);
+  ASSERT(test_assert_mat4_eq(t3, t5).status == 1)
 
   /* test translate_x */
   glmc_rotate_make(t1, GLM_PI_4f, GLM_YUP);
   glm_translate_make(t2, (vec3){34, 0, 0});
 
   glmc_mat4_mul(t1, t2, t3); /* R * T */
   glm_translate_x(t1, 34);
-  test_assert_mat4_eq(t1, t3);
+  ASSERT(test_assert_mat4_eq(t1, t3).status == 1)
 
   /* test translate_y */
   glmc_rotate_make(t1, GLM_PI_4f, GLM_YUP);
   glm_translate_make(t2, (vec3){0, 57, 0});
 
   glmc_mat4_mul(t1, t2, t3); /* R * T */
   glm_translate_y(t1, 57);
-  test_assert_mat4_eq(t1, t3);
+  ASSERT(test_assert_mat4_eq(t1, t3).status == 1)
 
   /* test translate_z */
   glmc_rotate_make(t1, GLM_PI_4f, GLM_YUP);
   glm_translate_make(t2, (vec3){0, 0, 36});
 
   glmc_mat4_mul(t1, t2, t3); /* R * T */
   glm_translate_z(t1, 36);
-  test_assert_mat4_eq(t1, t3);
+  ASSERT(test_assert_mat4_eq(t1, t3).status == 1)
 
   /* test rotate_x */
   glmc_rotate_make(t1, GLM_PI_4f, (vec3){1, 0, 0});
@@ -71,7 +70,7 @@ test_affine(void **state) {
   glmc_mat4_mul(t2, t1, t3); /* T * R */
 
   glm_rotate_x(t2, GLM_PI_4f, t2);
-  test_assert_mat4_eq(t2, t3);
+  ASSERT(test_assert_mat4_eq(t2, t3).status == 1)
 
   /* test rotate_y */
   glmc_rotate_make(t1, GLM_PI_4f, (vec3){0, 1, 0});
@@ -80,7 +79,7 @@ test_affine(void **state) {
   glmc_mat4_mul(t2, t1, t3); /* T * R */
 
   glm_rotate_y(t2, GLM_PI_4f, t2);
-  test_assert_mat4_eq(t2, t3);
+  ASSERT(test_assert_mat4_eq(t2, t3).status == 1)
 
   /* test rotate_z */
   glmc_rotate_make(t1, GLM_PI_4f, (vec3){0, 0, 1});
@@ -89,7 +88,7 @@ test_affine(void **state) {
   glmc_mat4_mul(t2, t1, t3); /* T * R */
 
   glm_rotate_z(t2, GLM_PI_4f, t2);
-  test_assert_mat4_eq(t2, t3);
+  ASSERT(test_assert_mat4_eq(t2, t3).status == 1)
 
   /* test rotate */
   glmc_rotate_make(t1, GLM_PI_4f, (vec3){0, 0, 1});
@@ -98,7 +97,7 @@ test_affine(void **state) {
   glmc_mat4_mul(t2, t1, t3); /* T * R */
   glmc_rotate(t2, GLM_PI_4f, (vec3){0, 0, 1});
 
-  test_assert_mat4_eq(t3, t2);
+  ASSERT(test_assert_mat4_eq(t3, t2).status == 1)
 
   /* test scale_uni */
   glmc_rotate_make(t1, GLM_PI_4f, GLM_YUP);
@@ -109,5 +108,7 @@ test_affine(void **state) {
   glmc_mat4_mul(t3, t4, t5); /* T * R * S */
 
   glm_scale_uni(t3, 3);
-  test_assert_mat4_eq(t3, t5);
+  ASSERT(test_assert_mat4_eq(t3, t5).status == 1)
+
+  TEST_SUCCESS
 }