summary refs log tree commit diff
path: root/www/text.causal.agency/005-testing-c.7
diff options
context:
space:
mode:
authorC. McEnroe <june@causal.agency>2019-07-12 22:11:16 -0400
committerC. McEnroe <june@causal.agency>2019-07-12 22:11:16 -0400
commitebacc3d0ee00212a20cb33b8f660ae73ecd5b95a (patch)
tree7a3ef26ccc341bbf17d3063c80a79440d2e88dbb /www/text.causal.agency/005-testing-c.7
parentAdd "Testing C" (diff)
downloadsrc-ebacc3d0ee00212a20cb33b8f660ae73ecd5b95a.tar.gz
src-ebacc3d0ee00212a20cb33b8f660ae73ecd5b95a.zip
Move to www/text.causal.agency
Diffstat (limited to 'www/text.causal.agency/005-testing-c.7')
-rw-r--r--www/text.causal.agency/005-testing-c.779
1 files changed, 79 insertions, 0 deletions
diff --git a/www/text.causal.agency/005-testing-c.7 b/www/text.causal.agency/005-testing-c.7
new file mode 100644
index 0000000..c3a47c1
--- /dev/null
+++ b/www/text.causal.agency/005-testing-c.7
@@ -0,0 +1,79 @@
+.Dd December 21, 2018
+.Dt TESTING-C 7
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm Testing C
+.Nd a simple unit testing setup
+.
+.Sh DESCRIPTION
+This is a simple approach
+to unit testing in C
+that I've used in a couple projects.
+At the bottom of a C file
+with some code I want to test,
+I add:
+.
+.Bd -literal -offset indent
+#ifdef TEST
+#include <assert.h>
+
+int main(void) {
+	assert(...);
+	assert(...);
+}
+
+#endif
+.Ed
+.
+.Pp
+This file normally produces a
+.Pa .o
+to be linked into the main binary.
+For testing,
+I produce separate binaries
+and run them with
+.Xr make 1 :
+.
+.Bd -literal -offset indent
+TESTS = foo.t bar.t
+
+\&.SUFFIXES: .t
+
+\&.c.t:
+	$(CC) $(CFLAGS) -DTEST $(LDFLAGS) $< $(LDLIBS) -o $@
+
+test: $(TESTS)
+	set -e; $(TESTS:%=./%;)
+.Ed
+.
+.Pp
+Note that the test binaries
+aren't linked with the rest of the code,
+so there is potential for simple stubbing or mocking.
+.
+.Pp
+To get the best output
+from C's simple
+.Xr assert 3 ,
+it's best to assert the result
+of a helper function
+which takes the expected output
+and the test input,
+rather than calling
+.Xr assert 3
+inside the helper function.
+This way,
+the message printed by the assert failure
+contains a useful line number
+and the expected output
+rather than just variable names.
+.
+.Pp
+For a real example,
+check
+.Lk https://code.causal.agency/june/catgirl/src/branch/master/term.c term.c
+from my IRC client project.
+.
+.Sh AUTHORS
+.An C. McEnroe Aq Mt june@causal.agency