renamed library to libtdd; added better print handling

Author: keeferrourke

Doxyfile

@@ -17,16 +17,13 @@
 # Project related configuration options
 #---------------------------------------------------------------------------
 
-#------------------
-things you need to change for each project
-#------------------
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
 # double-quotes, unless you are using Doxywizard) that should identify the
 # project for which the documentation is generated. This name is used in the
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "ctest"
+PROJECT_NAME           = "libtdd"
 
 
 # The INPUT tag is used to specify the files and/or directories that contain
@@ -37,20 +34,13 @@ PROJECT_NAME           = "ctest"
 
 INPUT                  = include
 
-
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
 OUTPUT_DIRECTORY       = docs
 
-
-
-#------------------
-things that can remain the same for each project unless you want to play
-#------------------
-
 # This tag specifies the encoding used for all characters in the config file
 # that follow. The default is UTF-8 which is also the encoding used for all text
 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
@@ -60,8 +50,6 @@ things that can remain the same for each project unless you want to play
 
 DOXYFILE_ENCODING      = UTF-8
 
-
-
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
@@ -81,7 +69,6 @@ PROJECT_BRIEF          =
 
 PROJECT_LOGO           =
 
-
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
 # will distribute the generated files over these directories. Enabling this

Makefile

@@ -1,4 +1,4 @@
-# libctest Makefile
+# libtdd Makefile
 # Keefer Rourke <mail@krourke.org>
 #
 # This Makefile creates dynamic and static library binaries for `libctest`.
@@ -13,6 +13,11 @@ SHELL = /bin/bash
 # determine platform
 UNAME = $(shell uname -s)
 
+# let make determine the compiler and archiver;
+# if it complains, try uncommenting the following lines
+# CC = gcc
+# AR = ar
+
 # set suffix list, to prevent confusion between different make programs
 # line 15 clears an implied suffix list, and line 16 sets a new one
 .SUFFIXES:
@@ -25,9 +30,7 @@ UNAME = $(shell uname -s)
 STD = -std=c99 -D_POSIX_C_SOURCE=199506L
 
 # library project structure
-CC	= gcc
-AR	= ar
-WD	= $(PWD)
+WD	:= $(PWD)
 INCLDIR	= $(WD)/include
 SRCDIR	= $(WD)/src
 OBJDIR	= $(WD)/obj
@@ -39,8 +42,8 @@ DOCDIR = docs
 TEXDIR = latex
 
 # library output
-_LIB	= libctest
-LIB	= $(addprefix $(OUTDIR)/, $(_LIB))
+OUTNAME	= libtdd
+LIB	= $(addprefix $(OUTDIR)/, $(OUTNAME))
 
 # files; here all object files will be stored in OBJDIR, with the same names
 # as corresponding c files from SRCDIR
@@ -49,7 +52,8 @@ _OBJS	= $(patsubst $(SRCDIR)/%.c, %.o, $(SRC))
 OBJS	= $(addprefix $(OBJDIR)/, $(_OBJS))
 
 # compilation flags
-CFLAGS	= -Wall -pedantic -g $(STD) $(DEFINE)
+# add extra flags on the command line by DEFINE=...
+CFLAGS	= -Wall -Wextra -pedantic -g $(STD) $(DEFINE)
 OFLAGS	= -pthread
 INCLUDE = -I$(INCLDIR)
 
@@ -60,15 +64,15 @@ all: lib dylib doc
 
 lib: $(OBJS) $(OUTDIR)
 	@$(AR) crs $(LIB).a $(OBJS)
-	@echo "Compiled libctest.a to $(OUTDIR)"
+	@echo "Compiled $(OUTNAME).a to $(OUTDIR)"
 
 dylib: $(OBJS) $(OUTDIR)
 ifeq ($(UNAME),Darwin)
 	@$(CC) -shared -o $(LIB).dylib $(OBJS)
-	@echo "Compiled libctest.dylib to $(OUTDIR)"
+	@echo "Compiled $(OUTNAME).dylib to $(OUTDIR)"
 else
 	@$(CC) -shared -o $(LIB).so $(OBJS)
-	@echo "Compiled libctest.so to $(OUTDIR)"
+	@echo "Compiled $(OUTNAME).so to $(OUTDIR)"
 endif
 
 # automatically compile all objects

README

@@ -1,10 +1,14 @@
-ctest
-=======
+libtdd
+======
+
+`libtdd` is a minimalist testing framework inspired by the Golang
+testing pkg. It is designed to provide a framework which may be used to
+build scaffolding during Test Driven Development (TDD).
+
+This small C library attempts to provide a consistent API for creating,
+running, and checking the results of tests. There is very little
+boilerplate required in the main function.
 
-`ctest` is a minimalist testing framework inspired by the Golang
-testing pkg. This small C library attempts to provide a consistent API
-for creating, running, and checking the results of tests. There is very
-little boilerplate required in the main function.
 
 Features
 --------
@@ -22,15 +26,15 @@ Build and usage
 The Makefile included with this project creates static and dynamic
 libraries in the `lib/` directory. To build this, simply run:
 
-    make lib    # libctest.a
-    make dylib  # libctest.so (or libctest.dylib on Darwin)
+    make lib    # libtdd.a
+    make dylib  # libtdd.so (or libtdd.dylib on macOS/Darwin)
 
 Colour output support can be enabled at compile time by including the
 `DEFINE=-DUSE_COLOUR` directive on the `make` line. ex.
 
     make dylib DEFINE=-DUSE_COLOUR  # enables pretty colour printing
 
-You can then include the outputted `libctest.so` or `libctest.a` in your
+You can then include the outputted `libtdd.so` or `libtdd.a` in your
 project as is required.
 
 API documentation can be compiled with Doxygen and LaTeX via:
@@ -39,7 +43,7 @@ API documentation can be compiled with Doxygen and LaTeX via:
 
 See the Makefile for other relevant build targets.
 
-**NOTE** Darwin/macOS support is untested at this time.
+**NOTE** macOS/Darwin support is untested at this time.
 This library was built and tested on Fedora 27 Workstation with glibc
 v2.26.
 
@@ -52,9 +56,9 @@ library can be found in the `examples/` directory of this project.
 It can be compiled and run as follows:
 
     make lib
-    gcc -o ctest_example -std=c99 -Iinclude examples/main.c -pthread \
-        -Llib -lctest
-    ./ctest_example
+    cc -o tdd_example -std=c99 -Iinclude examples/main.c -pthread \
+       -Llib -ltdd
+    ./tdd_example
 
 
 Conventions

examples/main.c

@@ -1,14 +1,14 @@
 /* main.c
  *
- * Example program demonstrating libctest usage.
+ * Example program demonstrating libtdd usage and features.
  * This program uses all the public features of the library.
  */
 #include <signal.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
-#include "ctest.h"
+#include "tdd.h"
 
 static void* test_errfunc(void* t);
 static void* test_failfunc(void* t);
@@ -21,30 +21,35 @@ int main(int argc, char* argv[]) {
 
     // suite_add is a variadic function that can be used to add an arbitrary
     // number of tests at once
+    // new tests are added with a function pointer, a name, and an optional
+    // description; if the description is to be omitted, you may pass NULL
     suite_add(s, 2,
               newtest(&test_timer, "test_timer",
                       "Manual benchmark. Requires timespan to be printed "
                       "manually."),
               newtest(&bench_func, "bench_func",
                       "Builtin benchmark. Execution timespan is printed "
                       "automatically below."));
+
     // suite_addtest is a function that simply appends a test to the list of
     // tests in the suite; could be used to programmatically add tests
-    suite_addtest(
-        s, newtest(&test_errfunc, "test_errfunc", "Produces an error."));
+    suite_addtest(s, newtest(&test_errfunc, "test_errfunc", "Raises error."));
+
     // suite_add can be called multiple times to add groups of tests to the
     // test suite
     suite_add(s, 2,
               newtest(&test_failfunc, "test_failfunc", "Fails immediately."),
-              newtest(&test_segvfunc, "test_segvfunc", "Raised SIGSEGV."));
+              newtest(&test_segvfunc, "test_segvfunc", "Raises SIGSEGV."));
 
     printf("Running tests ignoring failures.\n");
+
     suite_run(s, false);
     if (s->finished) {
         printf("Suite ran all tests.\n");
     } else {
         printf("Suite only ran %d tests.\n", s->test_index + 1);
     }
+    printf("Suite encountered: %d segmentation faults.\n", s->n_segv);
     printf("\n");
 
     // reset the test suite to demonstrate that it can be rerun with fatal
@@ -56,7 +61,7 @@ int main(int argc, char* argv[]) {
     if (s->finished) {
         printf("Suite ran all tests.\n");
     } else {
-        printf("Suite may not have run all tests!\n");
+        printf("Suite only ran %d tests.\n", s->test_index + 1);
     }
 
     // print summary statistics
@@ -74,13 +79,13 @@ int main(int argc, char* argv[]) {
 
 void* test_errfunc(void* t) {
     test_error(t, "a non-critical error ocurred.");
-    return t;
+    return NULL;
 }
 
 void* test_failfunc(void* t) {
     test_fail(t, "a critical error occurred!");
     printf("this code should not run unless fatal failures are disabled!\n");
-    return t;
+    return NULL;
 }
 
 void* test_timer(void* t) {
@@ -89,17 +94,17 @@ void* test_timer(void* t) {
     strcpy(s, "This function is being timed!");
     free(s);
     test_done(t);
-    return t;
+    return NULL;
 }
 
 void* bench_func(void* t) {
     char* s = calloc(128, sizeof(char));
     strcpy(s, "This function is being timed!");
     free(s);
-    return t;
+    return NULL;
 }
 
 void* test_segvfunc(void* t) {
     raise(SIGSEGV);
-    return t;
+    return NULL;
 }

include/ctest_signals.h include/signals.hinclude/ctest_signals.h renamed to include/signals.h

@@ -1,11 +1,12 @@
 /**
- * @file ctest_signals.c
+ * @file signals.c
  * @author Keefer Rourke <mail@krourke.org>
  * @date Wed Apr 11
- * @brief This file defines signal handlers for libctest.
+ * @brief This file defines signal handlers for libtdd.
+ * @private
  **/
-#ifndef __CTEST_SIGNAL_HANDLERS_H__
-#define __CTEST_SIGNAL_HANDLERS_H__
+#ifndef __TDD_SIGNAL_HANDLERS_H__
+#define __TDD_SIGNAL_HANDLERS_H__
 
 #include <signal.h>
 #include <stdlib.h>

include/ctest_strutil.h include/strutil.hinclude/ctest_strutil.h renamed to include/strutil.h

@@ -1,15 +1,21 @@
 /**
- * @file ctest_strutil.h
+ * @file strutil.h
  * @author Keefer Rourke <mail@krourke.org
  * @date 08 Apr 2018
- * @brief String format and manipulation functions and macros for libctest.
+ * @brief String format and manipulation functions and macros for libtdd.
  * @private
  */
-#ifndef __CTEST_UTIL_H__
-#define __CTEST_UTIL_H__
+#ifndef __TDD_STRING_UTIL_H__
+#define __TDD_STRING_UTIL_H__
 
+#include <stdio.h>
 #include <stdlib.h>
 
+/**
+ * INDENT is a macro that prints 6 space characters to the FILE* x
+ **/
+#define INDENT(x) fprintf(x, "      ")
+
 int  __hasprefix(char* str, char* pre);
 void __print_error(FILE* f, char* str);
 void __print_warning(FILE* f, char* str);