Add initial setup for unit tests

Author: kyleect

CMakeLists.txt

@@ -1,6 +1,8 @@
 # CMakeLists.txt
 cmake_minimum_required(VERSION 3.22)
 
+enable_testing()
+
 project(clox LANGUAGES C)
 
 # -----------------------------------------------------------------
@@ -37,6 +39,13 @@ set_source_files_properties(${VERSION_C} PROPERTIES GENERATED TRUE)
 file(GLOB SRC_FILES CONFIGURE_DEPENDS src/*.c)
 list(FILTER SRC_FILES EXCLUDE REGEX ".*/version\\.c$")
 
+# ---
+# Test Source Files
+# ---
+file(GLOB UNIT_TEST_SRCS unit/*.c)
+
+option(BUILD_TESTS "Build unit‑tests for project" OFF)
+
 # -----------------------------------------------------------------
 # Executables
 # -----------------------------------------------------------------
@@ -56,6 +65,36 @@ target_link_libraries(clox-test     PRIVATE readline m)
 add_dependencies(clox generate_version_c)
 add_dependencies(clox-test generate_version_c)
 
+if (BUILD_TESTS)
+
+# -----------------------------------------------------------------
+# Tests
+# -----------------------------------------------------------------
+
+add_executable(clox-version-unit-test unit/version.c ${VERSION_C})
+add_dependencies(clox-version-unit-test generate_version_c)
+add_test(
+    NAME   clox-version-unit-test
+    COMMAND clox-version-unit-test
+)
+
+add_executable(clox-token-token-test unit/token.c src/token.c ${VERSION_C})
+add_dependencies(clox-token-token-test generate_version_c)
+add_test(
+    NAME   clox-token-unit-test
+    COMMAND clox-token-unit-test
+)
+
+add_executable(clox-value-unit-test unit/value.c src/value.c src/object.c src/hashtable.c src/chunk.c src/memory.c src/vm.c src/assert.c src/scanner.c src/compiler.c src/token.c src/native.c ${VERSION_C})
+add_dependencies(clox-value-unit-test generate_version_c)
+target_link_libraries(clox-value-unit-test     PRIVATE readline m)
+add_test(
+    NAME   clox-value-unit-test
+    COMMAND clox-value-unit-test
+)
+
+endif()
+
 # -----------------------------------------------------------------
 # Coverage option
 # -----------------------------------------------------------------
@@ -70,4 +109,7 @@ if(ENABLE_COVERAGE)
 
     target_compile_options(clox-test PRIVATE ${COVERAGE_COMPILE_FLAGS})
     target_link_options(clox-test PRIVATE ${COVERAGE_LINK_FLAGS})
+
+    target_compile_options(clox-unit-test PRIVATE ${COVERAGE_COMPILE_FLAGS})
+    target_link_options(clox-unit-test    PRIVATE ${COVERAGE_LINK_FLAGS})
 endif()

justfile

@@ -24,6 +24,9 @@ cmake:
 build: generate_version_c
     ./scripts/build.sh
 
+build-tests: generate_version_c
+    ./scripts/build-tests.sh
+
 # Clean the build artifacts
 clean:
     ./scripts/clean.sh
@@ -44,6 +47,9 @@ install:
 test *args: build
     ./scripts/tests.sh {{ args }}
 
+unit: build-tests
+    ./scripts/unit.sh
+
 # Run the tests with coverage enabled
 coverage *args:
     ./scripts/coverage.sh {{ args }}

scripts/README.md

@@ -44,6 +44,14 @@ Run `./scripts/coverage.sh` or `just coverage` to generate code coverage data.
 
 Outputs `lcov.info` at the root of the project.
 
+## Unit Tests
+
+Run `./sciprts/build-tests.sh && ./scripts/unit.sh` or `just unit` to run the unit tests.
+
+## Build Unit Tests
+
+Run `./scripts/build-tests.sh` or `just build-tests` to build the [unit tests](#unit-tests).
+
 ## Run Examples
 
 ```sh

scripts/build-tests.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -e
+
+BUILD_DIR=build
+ENABLE_COVERAGE=${ENABLE_COVERAGE:-OFF}
+
+cmake -S . -B "$BUILD_DIR" -DENABLE_COVERAGE=$ENABLE_COVERAGE -DBUILD_TESTS=on
+cmake --build "$BUILD_DIR"

scripts/unit.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+
+cd build
+ctest --verbose

src/token.h

@@ -50,7 +50,8 @@ typedef enum {
   TOKEN_WHILE,
 
   TOKEN_ERROR,
-  TOKEN_EOF
+  TOKEN_EOF,
+  NumberOfDefinedTokens
 } TokenType;
 
 typedef struct {

unit/token.c

@@ -0,0 +1,11 @@
+#include <assert.h>
+#include <stdio.h>
+#include <string.h>
+
+#include "../src/token.h"
+
+int main(void) {
+  assert(NumberOfDefinedTokens == 44);
+  assert(strcmp(tokenTypeToString(TOKEN_AND), "TOKEN_AND") == 0);
+  return 0;
+}

unit/value.c

@@ -0,0 +1,26 @@
+#include <assert.h>
+#include <stdio.h>
+#include <string.h>
+
+#include "../src/value.h"
+
+#define TEST(name, value, expected)                                            \
+  static void name() {                                                         \
+    char buffer[sizeof(expected)];                                             \
+    valueToString(value, buffer, sizeof(buffer));                              \
+    assert(strcmp(expected, buffer) == 0);                                     \
+  }
+
+TEST(test_nil, NIL_VAL, "nil");
+TEST(test_number, NUMBER_VAL(123), "123.000000");
+TEST(test_bool_true, BOOL_VAL(true), "true");
+TEST(test_bool_false, BOOL_VAL(false), "false");
+
+int main(void) {
+  test_nil();
+  test_number();
+  test_bool_true();
+  test_bool_false();
+
+  return 0;
+}

unit/version.c

@@ -0,0 +1,9 @@
+#include <assert.h>
+#include <string.h>
+
+#include "../src/version.h"
+
+int main(void) {
+  assert(strcmp(CLOX_VERSION, "0.1.0") == 0);
+  return 0;
+}