From f573ff83669ef5dcd38bd6d5a9aaad3e4cf9e64b Mon Sep 17 00:00:00 2001 From: Dominic Masters Date: Wed, 1 Nov 2023 23:52:36 -0500 Subject: [PATCH] Adding unit tests. --- .gitmodules | 5 +- CMakeLists.txt | 12 ++- lib/CMakeLists.txt | 6 +- lib/Catch2 | 1 + src/dawn/CMakeLists.txt | 20 +++-- src/dawn/assert/CMakeLists.txt | 6 ++ src/dawn/assert/_test_.assert.cpp | 77 +++++++++++++++++++ src/dawn/assert/assert.cpp | 2 +- src/dawn/dawnlibs.hpp | 4 +- .../display/font/truetype/TrueTypeShared.hpp | 2 + src/dawn/util/CMakeLists.txt | 11 +++ src/dawn/util/_test_.memory.cpp | 27 +++++++ src/dawnarchiveasset/CMakeLists.txt | 1 - src/dawnfileasset/CMakeLists.txt | 1 - 14 files changed, 158 insertions(+), 17 deletions(-) create mode 160000 lib/Catch2 create mode 100644 src/dawn/assert/_test_.assert.cpp create mode 100644 src/dawn/util/_test_.memory.cpp diff --git a/.gitmodules b/.gitmodules index a6dc1c73..a76824bb 100644 --- a/.gitmodules +++ b/.gitmodules @@ -18,4 +18,7 @@ url = https://gitlab.freedesktop.org/freetype/freetype.git [submodule "lib/libarchive"] path = lib/libarchive - url = https://github.com/libarchive/libarchive \ No newline at end of file + url = https://github.com/libarchive/libarchive +[submodule "lib/Catch2"] + path = lib/Catch2 + url = https://github.com/catchorg/Catch2.git diff --git a/CMakeLists.txt b/CMakeLists.txt index a25a21f7..430ac5ae 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -34,6 +34,10 @@ project(Dawn LANGUAGES C CXX ) +# Setup tests +add_executable(dawntests) +target_link_libraries(dawntests PRIVATE Catch2::Catch2WithMain) + # Add tools add_subdirectory(tools) @@ -41,4 +45,10 @@ add_subdirectory(tools) add_subdirectory(lib) # Add Project Files -add_subdirectory(src) \ No newline at end of file +add_subdirectory(src) + +# Run tests +list(APPEND CMAKE_MODULE_PATH ${catch2_SOURCE_DIR}/extras) +include(CTest) +include(Catch) +catch_discover_tests(dawntests) \ No newline at end of file diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt index 02bf4dfa..6091b390 100644 --- a/lib/CMakeLists.txt +++ b/lib/CMakeLists.txt @@ -45,7 +45,11 @@ if(DAWN_TARGET_OPENAL) add_subdirectory(AudioFile) endif() -# Test +# Catch2 Testing Framework +set(catch2_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/Catch2 CACHE INTERNAL ${DAWN_CACHE_TARGET}) +add_subdirectory(Catch2) + +# Emscripten (TESTING ONLY) if(DEFINED DAWN_EMSCRIPTEN_FLAGS) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${DAWN_EMSCRIPTEN_FLAGS}" CACHE INTERNAL ${DAWN_CACHE_TARGET}) set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${DAWN_EMSCRIPTEN_FLAGS}" CACHE INTERNAL ${DAWN_CACHE_TARGET}) diff --git a/lib/Catch2 b/lib/Catch2 new file mode 160000 index 00000000..a8cf3e67 --- /dev/null +++ b/lib/Catch2 @@ -0,0 +1 @@ +Subproject commit a8cf3e671047da6e7bf6c3c0d9a2178afeed1b54 diff --git a/src/dawn/CMakeLists.txt b/src/dawn/CMakeLists.txt index 4cd6c9c7..e22ad24f 100644 --- a/src/dawn/CMakeLists.txt +++ b/src/dawn/CMakeLists.txt @@ -13,16 +13,9 @@ target_link_libraries(${DAWN_TARGET_NAME} # Includes target_include_directories(${DAWN_TARGET_NAME} PUBLIC - ${DAWN_SHARED_INCLUDES} ${CMAKE_CURRENT_LIST_DIR} ) - -target_sources(${DAWN_TARGET_NAME} - PRIVATE - ${DAWN_SHARED_SOURCES} -) - # Subdirs add_subdirectory(assert) add_subdirectory(asset) @@ -43,6 +36,17 @@ add_subdirectory(util) # Definitions target_compile_definitions(${DAWN_TARGET_NAME} PUBLIC - ${DAWN_SHARED_DEFINITIONS} DAWN_DEBUG_BUILD=${DAWN_DEBUG_BUILD} +) + +# Tests +target_link_libraries(dawntests + PUBLIC + glm + freetype +) + +target_include_directories(dawntests + PUBLIC + ${CMAKE_CURRENT_LIST_DIR} ) \ No newline at end of file diff --git a/src/dawn/assert/CMakeLists.txt b/src/dawn/assert/CMakeLists.txt index a22374f6..a9f2dfca 100644 --- a/src/dawn/assert/CMakeLists.txt +++ b/src/dawn/assert/CMakeLists.txt @@ -6,4 +6,10 @@ target_sources(${DAWN_TARGET_NAME} PRIVATE assert.cpp +) + +target_sources(dawntests + PRIVATE + assert.cpp + _test_.assert.cpp ) \ No newline at end of file diff --git a/src/dawn/assert/_test_.assert.cpp b/src/dawn/assert/_test_.assert.cpp new file mode 100644 index 00000000..9549b110 --- /dev/null +++ b/src/dawn/assert/_test_.assert.cpp @@ -0,0 +1,77 @@ +// Copyright (c) 2023 Dominic Masters +// +// This software is released under the MIT License. +// https://opensource.org/licenses/MIT + +#include +#include "assert.hpp" + +TEST_CASE("assertTrue", "[assert]") { + SECTION("true") { + assertTrue(true, "This should not fail"); + } + + SECTION("false") { + REQUIRE_THROWS(assertTrue(false, "This should fail")); + } +} + +TEST_CASE("assertFalse", "[assert]") { + SECTION("true") { + REQUIRE_THROWS(assertFalse(true, "This should fail")); + } + + SECTION("false") { + assertFalse(false, "This should not fail"); + } +} + +TEST_CASE("assertUnreachable", "[assert]") { + REQUIRE_THROWS(assertUnreachable("This should fail all the time.")); +} + +TEST_CASE("assertNotNull", "[assert]") { + SECTION("nullptr") { + REQUIRE_THROWS(assertNotNull(nullptr, "This should fail")); + } + + SECTION("NULL") { + REQUIRE_THROWS(assertNotNull(NULL, "This should fail")); + } + + SECTION("not nullptr or NULL") { + assertNotNull((void*)0x1, "This should not fail"); + } +} + +TEST_CASE("assertNull", "[assert]") { + SECTION("nullptr") { + assertNull(nullptr, "This should not fail"); + } + + SECTION("NULL") { + assertNull(NULL, "This should not fail"); + } + + SECTION("not nullptr or NULL") { + REQUIRE_THROWS(assertNull((void*)0x1, "This should fail")); + } +} + +TEST_CASE("assertMapHasKey", "[assert]") { + SECTION("has key") { + std::map map; + map["key"] = "value"; + assertMapHasKey(map, "key", "This should not fail"); + } + + SECTION("does not have key") { + std::map map; + map["different_key"] = "Some other value"; + REQUIRE_THROWS(assertMapHasKey(map, "key", "This should fail")); + } +} + +TEST_CASE("assertDeprecated", "[assert]") { + REQUIRE_THROWS(assertDeprecated("This should fail")); +} \ No newline at end of file diff --git a/src/dawn/assert/assert.cpp b/src/dawn/assert/assert.cpp index 0ca945ae..16799950 100644 --- a/src/dawn/assert/assert.cpp +++ b/src/dawn/assert/assert.cpp @@ -31,5 +31,5 @@ void assertTrueImplement( vfprintf(stderr, message, argptr); va_end(argptr); fprintf(stderr, "\n"); - abort(); + throw std::runtime_error("Assert failed."); } diff --git a/src/dawn/dawnlibs.hpp b/src/dawn/dawnlibs.hpp index ed50c914..05ed6c48 100644 --- a/src/dawn/dawnlibs.hpp +++ b/src/dawn/dawnlibs.hpp @@ -32,9 +32,7 @@ extern "C" { #include #include #include - -#include -#include FT_FREETYPE_H +#include #include #include diff --git a/src/dawn/display/font/truetype/TrueTypeShared.hpp b/src/dawn/display/font/truetype/TrueTypeShared.hpp index 1079a20a..101e2187 100644 --- a/src/dawn/display/font/truetype/TrueTypeShared.hpp +++ b/src/dawn/display/font/truetype/TrueTypeShared.hpp @@ -4,6 +4,8 @@ // https://opensource.org/licenses/MIT #pragma once +#include +#include FT_FREETYPE_H #include "util/flag.hpp" #define TRUE_TYPE_CHAR_BEGIN 0x00 diff --git a/src/dawn/util/CMakeLists.txt b/src/dawn/util/CMakeLists.txt index 87767fe9..e7a46feb 100644 --- a/src/dawn/util/CMakeLists.txt +++ b/src/dawn/util/CMakeLists.txt @@ -10,3 +10,14 @@ target_sources(${DAWN_TARGET_NAME} UsageLock.cpp Xml.cpp ) + + +# Tests +target_sources(dawntests + PRIVATE + memory.cpp + UsageLock.cpp + Xml.cpp + + _test_.memory.cpp +) \ No newline at end of file diff --git a/src/dawn/util/_test_.memory.cpp b/src/dawn/util/_test_.memory.cpp new file mode 100644 index 00000000..67f8ad92 --- /dev/null +++ b/src/dawn/util/_test_.memory.cpp @@ -0,0 +1,27 @@ +// Copyright (c) 2023 Dominic Masters +// +// This software is released under the MIT License. +// https://opensource.org/licenses/MIT + +#include +#include "util/memory.hpp" +#include "assert/assert.hpp" + +TEST_CASE("memorycallMalloc", "[memory]") { + SECTION("memory isn't null") { + void *p = memoryCallMalloc(10); + REQUIRE(p != nullptr); + REQUIRE(p != NULL); + memoryCallFree(p); + } + + SECTION("memory is writeable") { + void *p = memoryCallMalloc(10); + for(int i = 0; i < 10; i++) { + ((char*)p)[i] = 'a'; + } + REQUIRE(((char*)p)[0] == 'a'); + REQUIRE(((char*)p)[9] == 'a'); + memoryCallFree(p); + } +} \ No newline at end of file diff --git a/src/dawnarchiveasset/CMakeLists.txt b/src/dawnarchiveasset/CMakeLists.txt index 65badf81..672a9928 100644 --- a/src/dawnarchiveasset/CMakeLists.txt +++ b/src/dawnarchiveasset/CMakeLists.txt @@ -12,7 +12,6 @@ target_link_libraries(${DAWN_TARGET_NAME} # Includes target_include_directories(${DAWN_TARGET_NAME} PUBLIC - ${DAWN_SHARED_INCLUDES} ${CMAKE_CURRENT_LIST_DIR} ) diff --git a/src/dawnfileasset/CMakeLists.txt b/src/dawnfileasset/CMakeLists.txt index 788d08e1..053ed9c8 100644 --- a/src/dawnfileasset/CMakeLists.txt +++ b/src/dawnfileasset/CMakeLists.txt @@ -6,7 +6,6 @@ # Includes target_include_directories(${DAWN_TARGET_NAME} PUBLIC - ${DAWN_SHARED_INCLUDES} ${CMAKE_CURRENT_LIST_DIR} )