Add testing infrastructure (#17)

* Adding three simple tests.

* Updating Makefile to be able to compile tests

* Exclude compiled tests from github.

* Adding -g to gcc again so we include debug information.

* Added check unit test library to Vagrant

Author: rogersm

.gitignore

@@ -5,3 +5,4 @@ guildmud
 *.log
 .vscode/settings.json
 src/libguildmud.a
+tests/*.run

Makefile

@@ -1,27 +1,40 @@
 CC      = gcc
-C_FLAGS = -Wall -g -pedantic -Werror
+C_FLAGS = -Wall -pedantic -Werror -g
 L_FLAGS = -lz -lpthread -lsqlite3
+C_FLAGS_TEST = -Wall -pedantic -Werror -g -Isrc/
+L_FLAGS_TEST = -lz -lpthread -lsqlite3 -lcheck -Lsrc/
 
 SRC_FILES = $(wildcard src/*.c)
 OBJ_FILES = $(filter-out src/main.o, $(SRC_FILES:.c=.o))
-
+CHECK_FILES = $(wildcard tests/*.test)
+CHECK_FILES_EXE = $(CHECK_FILES:.test=.run)
 
 all: src/main.o src/libguildmud.a
-	$(CC) -o src/guildmud src/main.o src/libguildmud.a $(L_FLAGS)
+	@$(CC) -o src/guildmud src/main.o src/libguildmud.a $(L_FLAGS)
 
 src/libguildmud.a: $(OBJ_FILES)
-	ar ru $@ $^
-	ranlib $@
+	@ar ru $@ $^
+	@ranlib $@
 
 .c.o: all
-	$(CC) -c $(C_FLAGS) -o $@ $<
+	@$(CC) -c $(C_FLAGS) -o $@ $<
 
-clean:
-	@echo Cleaning code $< ...
-	@rm -f src/*.o src/guildmud src/libguildmud.a src/*~
 
-test:
-	@echo To be implemented shortly...
+test: $(CHECK_FILES_EXE)
+	@echo Compiling tests...
+	
+
+tests/%.run: tests/%.c src/libguildmud.a
+	@$(CC) -o $@ $< src/libguildmud.a $(C_FLAGS_TEST) $(L_FLAGS_TEST) 
+	# $@ -- Uncomment if we want to run the compiled test
+
+tests/%.c: tests/%.test
+	@checkmk $< > $@
 
 install:
 	@echo To be implemented shortly...
+
+.PHONY: clean
+clean:
+	@echo Cleaning code ...
+	@rm -rf src/*.o src/guildmud src/libguildmud.a src/*~ tests/*.c tests/run* tests/*.dSYM src/*.dSYM

Vagrantfile

@@ -30,6 +30,7 @@ Vagrant.configure("2") do |config|
   config.vm.provision "shell", path: "vagrant/provisioners/home.sh"
   config.vm.provision "shell", path: "vagrant/provisioners/c.sh"
   config.vm.provision "shell", path: "vagrant/provisioners/sqlite.sh"
+  config.vm.provision "shell", path: "vagrant/provisioners/check.sh"
 
   # make /vagrant the working directory for all commands
   config.exec.commands '*', directory: '/vagrant'

tests/test_crypt.test

@@ -0,0 +1,17 @@
+#include <string.h>
+#include <stdlib.h>
+#include <sys/types.h>
+#include <ctype.h>
+#include <stdio.h>
+#include <stdarg.h>
+#include <check.h>
+
+#include "mud.h"
+
+#suite crypt_c
+#tcase check_is_prefix
+
+#test crypt_code_salt
+    ck_assert_str_eq("sanem1WDqdnxo", crypt("code", "salt"));
+#test crypt_guildmud_cprogramming
+    ck_assert_str_eq("cp.kzgf79whuQ", crypt("guildmud", "cprogramming"));

tests/test_strings.test

@@ -0,0 +1,23 @@
+#include <string.h>
+#include <stdlib.h>
+#include <sys/types.h>
+#include <ctype.h>
+#include <stdio.h>
+#include <stdarg.h>
+#include <check.h>
+
+#include "mud.h"
+
+#suite strings_c
+#tcase check_is_prefix
+
+#test is_prefix_A_A
+    ck_assert_msg(TRUE == is_prefix("A", "A"), "is_prefix A, A should have returned true");
+#test is_prefix_A_AA
+    ck_assert_msg(TRUE == is_prefix("A", "AA"), "is_prefix A, AA should have returned true");
+#test is_prefix_A_AAA
+    ck_assert_msg(TRUE == is_prefix("A", "AAA"), "is_prefix A, AAA should have returned true");
+#test is_prefix_A_AAAZ
+    ck_assert_msg(TRUE == is_prefix("A", "AAAZ"), "is_prefix A, AAAZ should have returned true");
+#test is_prefix_A_B_fail
+    ck_assert_msg(TRUE != is_prefix("A", "B"), "is_prefix A, B should have returned false");

tests/test_utils.test

@@ -0,0 +1,27 @@
+#include <string.h>
+#include <stdlib.h>
+#include <sys/types.h>
+#include <ctype.h>
+#include <stdio.h>
+#include <stdarg.h>
+#include <check.h>
+
+#include "mud.h"
+
+#suite utils_c
+#tcase check_name
+
+#test check_name_valid
+    ck_assert_msg(TRUE == check_name("abc"), "check_name abc must not fail is an alpha string >=3 and <=12");
+    ck_assert_msg(TRUE == check_name("ALFA"), "check_name ALFA must not fail is an alpha string >=3 and <=12");
+    ck_assert_msg(TRUE == check_name("OMEGA"), "check_name OMEGA must not fail is an alpha string >=3 and <=12");
+    ck_assert_msg(TRUE == check_name("first"), "check_name first must not fail is an alpha string >=3 and <=12");
+    ck_assert_msg(TRUE == check_name("second"), "check_name second must not fail is an alpha string >=3 and <=12");
+    ck_assert_msg(TRUE == check_name("abcdefghijkl"), "check_name abcdefghijkl must not fail is an alpha string >=3 and <=12");
+
+#test check_name_fail
+    ck_assert_msg(FALSE == check_name("guild mud"), "check_name /guild mud/ must fail because has an /space/");
+    ck_assert_msg(FALSE == check_name("ab"), "check_name /ab/ must fail because has less < 3 characters");
+    ck_assert_msg(FALSE == check_name("abcdefghijklm"), "check_name /abcdefghijklm/ must fail because has > 13 chars");
+    ck_assert_msg(FALSE == check_name("guild*mud"), "check_name /guild*mud/ must fail because has an /*/");
+    ck_assert_msg(FALSE == check_name("guild1mud"), "check_name /guild1mud/ must fail because has an /1/");

vagrant/provisioners/check.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+apt-get update
+apt-get install check