added working unit tests

Stateford · Feb 11, 2023 · 0451e96 · 0451e96
1 parent 477a767
commit 0451e96
Show file tree

Hide file tree

Showing 19 changed files with 190 additions and 309 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -3,4 +3,5 @@ cmake_minimum_required(VERSION 3.24)
 project(Display-Lock)
 
 add_subdirectory(src)
-target_include_directories(${PROJECT_NAME} PRIVATE include)
+
+add_subdirectory(tests)
diff --git a/CMakePresets.json b/CMakePresets.json
@@ -23,7 +23,7 @@
             "name": "windows",
             "displayName": "Windows Config",
             "hidden": true,
-            "description": "Sets Ninja generator, build and install directory",
+            "description": "Sets MSVC generator, build and install directory",
             "generator": "Visual Studio 17 2022",
             "condition": {
                 "type": "equals",
@@ -33,40 +33,51 @@
         },
         {
             "name": "windows-debug",
-            "inherits": ["default", "windows"],
+            "inherits": [
+                "default",
+                "windows"
+            ],
             "displayName": "Windows Debug",
-            "description": "Sets Ninja generator, build and install directory",
             "cacheVariables": {
                 "CMAKE_BUILD_TYPE": "Debug"
             }
         },
         {
             "name": "windows-release",
-            "inherits": ["default", "windows"],
+            "inherits": [
+                "default",
+                "windows"
+            ],
             "displayName": "Windows Release",
-            "description": "Sets Ninja generator, build and install directory",
             "cacheVariables": {
                 "CMAKE_BUILD_TYPE": "Release"
             }
         }
     ],
     "buildPresets": [
         {
-            "name": "windows-debug",
-            "configurePreset": "windows-debug"
+            "name": "Debug",
+            "configurePreset": "windows-debug",
+            "configuration": "Debug"
         },
         {
-            "name": "windows-release",
-            "configurePreset": "windows-release"
+            "name": "Release",
+            "configurePreset": "windows-release",
+            "configuration": "Release"
         }
     ],
     "testPresets": [
         {
             "name": "default",
             "hidden": true,
             "configurePreset": "default",
-            "output": {"outputOnFailure": true},
-            "execution": {"noTestsAction": "error", "stopOnFailure": true}
+            "output": {
+                "outputOnFailure": true
+            },
+            "execution": {
+                "noTestsAction": "error",
+                "stopOnFailure": true
+            }
         },
         {
             "name": "windows-debug",

diff --git a/include/common.h b/include/common.h
@@ -18,7 +18,7 @@
 #pragma once
 
 #include <Windows.h>
-#include "resources/resource.h"
+#include "resource.h"
 
 #define WINDOW_VIEW 0
 #define SETTINGS_VIEW 1

diff --git a/include/settings.h b/include/settings.h
@@ -22,9 +22,9 @@
 
 void initalizeSettings(HWND hDlg, SETTINGS_VIEW_CONTROLS *settingsControls);
 void setSettingsDlg(HWND hDlg, SETTINGS settings);
-void defaultSettings(SETTINGS *settings, wchar_t *versionStr);
-BOOL checkVersion(SETTINGS *settings, wchar_t *versionStr);
+void defaultSettings(SETTINGS *settings, const wchar_t *versionStr);
+BOOL checkVersion(SETTINGS *settings, const wchar_t *versionStr);
 BOOL findPath(wchar_t *path);
 BOOL createDirectory(wchar_t *outPath);
-BOOL readSettings(SETTINGS *settings, wchar_t *versionStr, wchar_t *path);
-BOOL writeSettings(SETTINGS settings, wchar_t *path);
+BOOL readSettings(SETTINGS *settings, const wchar_t *versionStr, const wchar_t *path);
+BOOL writeSettings(SETTINGS settings, const wchar_t *path);
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -1,17 +1,13 @@
 
 enable_language("RC")
 
+add_subdirectory(components)
+
 add_executable(${PROJECT_NAME} WIN32
-    DisplayLock.c
+    main.c
     ui.c
-    menu.c
-    notify.c
-    settings.c
-    update.c
-    win.c
-    applications.c
 )
-target_link_libraries(${PROJECT_NAME} PRIVATE version Shlwapi winhttp iphlpapi)
-target_compile_definitions(${PROJECT_NAME} PUBLIC -DUNICODE)
+target_link_libraries(${PROJECT_NAME} PUBLIC display_lock_components)
+target_include_directories(display_lock_components PUBLIC resources)
 
 add_subdirectory(resources)
diff --git a/src/components/CMakeLists.txt b/src/components/CMakeLists.txt
@@ -0,0 +1,13 @@
+project(display_lock_components)
+
+add_library(${PROJECT_NAME} STATIC
+    menu.c
+    notify.c
+    settings.c
+    update.c
+    win.c
+    applications.c
+)
+target_compile_definitions(${PROJECT_NAME} PUBLIC -DUNICODE)
+target_include_directories(${PROJECT_NAME} PUBLIC ${CMAKE_SOURCE_DIR}/include)
+target_link_libraries(${PROJECT_NAME} PUBLIC version Shlwapi winhttp iphlpapi)
diff --git a/src/applications.c → src/components/applications.c b/src/applications.c → src/components/applications.c
diff --git a/src/menu.c → src/components/menu.c b/src/menu.c → src/components/menu.c
diff --git a/src/notify.c → src/components/notify.c b/src/notify.c → src/components/notify.c
diff --git a/src/settings.c → src/components/settings.c b/src/settings.c → src/components/settings.c
@@ -37,7 +37,7 @@ void setSettingsDlg(HWND hDlg, SETTINGS settings)
     return;
 }
 
-void defaultSettings(SETTINGS *settings, wchar_t *versionStr)
+void defaultSettings(SETTINGS *settings, const wchar_t *versionStr)
 {
     strcpy(settings->header, "DLOCK");
     settings->version = 0;
@@ -54,7 +54,7 @@ void defaultSettings(SETTINGS *settings, wchar_t *versionStr)
     settings->checkUpdateStartup = TRUE;
 }
 
-BOOL checkVersion(SETTINGS *settings, wchar_t *versionStr)
+BOOL checkVersion(SETTINGS *settings, const wchar_t *versionStr)
 {
     if (strcmp(settings->header, "DLOCK") != 0 || wcslen(versionStr) == 0)
         return FALSE;
@@ -108,7 +108,7 @@ BOOL createDirectory(wchar_t *outPath)
     return TRUE;
 }
 
-BOOL readSettings(SETTINGS *settings, wchar_t *versionStr, wchar_t *path)
+BOOL readSettings(SETTINGS *settings, const wchar_t *versionStr, const wchar_t *path)
 {
     FILE *file = _wfopen(path, TEXT("rb"));
 
@@ -131,7 +131,7 @@ BOOL readSettings(SETTINGS *settings, wchar_t *versionStr, wchar_t *path)
     return TRUE;
 }
 
-BOOL writeSettings(SETTINGS settings, wchar_t *path)
+BOOL writeSettings(SETTINGS settings, const wchar_t *path)
 {
     // if loadstring could not be read, do not write the file
     if (settings.version <= 0 || strcmp(settings.header, "DLOCK") != 0)

diff --git a/src/update.c → src/components/update.c b/src/update.c → src/components/update.c
diff --git a/src/win.c → src/components/win.c b/src/win.c → src/components/win.c
diff --git a/src/DisplayLock.c → src/main.c b/src/DisplayLock.c → src/main.c
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -1,2 +1,44 @@
 project(display-lock-unittests)
 
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_BINARY_DIR}/tests)
+list(APPEND CMAKE_PREFIX_PATH ${CMAKE_BINARY_DIR}/tests)
+
+message(STATUS "BINARY PATH ${CMAKE_BINARY_DIR}")
+
+if(NOT EXISTS "${CMAKE_BINARY_DIR}/conan.cmake")
+  message(STATUS "Downloading conan.cmake from https://github.com/conan-io/cmake-conan")
+  file(DOWNLOAD "https://raw.githubusercontent.com/conan-io/cmake-conan/0.18.1/conan.cmake"
+                "${CMAKE_BINARY_DIR}/conan.cmake"
+                TLS_VERIFY ON)
+endif()
+
+include(${CMAKE_BINARY_DIR}/conan.cmake)
+
+conan_cmake_configure(
+    REQUIRES gtest/1.13.0 
+    GENERATORS cmake_find_package
+)
+
+conan_cmake_autodetect(settings)
+
+conan_cmake_install(
+    PATH_OR_REFERENCE .
+    BUILD missing
+    REMOTE conancenter
+    SETTINGS ${settings}
+)
+
+enable_testing()
+
+find_package(GTest REQUIRED)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+add_executable(${PROJECT_NAME} test_settings.cpp)
+target_link_libraries(${PROJECT_NAME} PRIVATE GTest::gtest_main display_lock_components)
+target_include_directories(${PROJECT_NAME} PRIVATE ${CMAKE_SOURCE_DIR}/include ${CMAKE_SOURCE_DIR}/src/resources)
+
+add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
+    COMMAND ${CMAKE_COMMAND} -E copy_directory
+        ${CMAKE_CURRENT_SOURCE_DIR}/test_resources $<TARGET_FILE_DIR:${PROJECT_NAME}>)
diff --git a/tests/readTests/readTests.md → tests/test_resources/readTests.md b/tests/readTests/readTests.md → tests/test_resources/readTests.md
diff --git a/tests/readTests/test1.DLOCK → tests/test_resources/test1.DLOCK b/tests/readTests/test1.DLOCK → tests/test_resources/test1.DLOCK
diff --git a/tests/test_settings.cpp b/tests/test_settings.cpp
@@ -0,0 +1,97 @@
+#include "gtest/gtest.h"
+
+extern "C" {
+#include "settings.h"
+}
+
+// #define WIN32_LEAN_AND_MEAN // Exclude rarely-used stuff from Windows headers
+// #include <Windows.h>
+#include <iostream>
+#include <filesystem>
+#include <source_location>
+
+
+namespace {
+
+    // settings.h
+    TEST(SettingsTest, DefaultSettings)
+    {
+        SETTINGS settings;
+        defaultSettings(&settings, L"5");
+
+        // It's impossible to test the default version, as it's determined at run time
+        ASSERT_STREQ(settings.header, "DLOCK");
+        ASSERT_EQ(settings.version, 5);
+        ASSERT_EQ(settings.borderless, false);
+        ASSERT_EQ(settings.foreground, false);
+        ASSERT_EQ(settings.fullScreen, false);
+        ASSERT_EQ(settings.minimize, true);
+    }
+
+    TEST(SettingsTest, CheckVersion)
+    {
+        SETTINGS settings;
+
+        defaultSettings(&settings, L"5");
+        ASSERT_EQ(checkVersion(&settings, L"5"), true);
+        ASSERT_EQ(checkVersion(&settings, L"0005"), true);
+        ASSERT_EQ(checkVersion(&settings, L"15"), false);
+        ASSERT_EQ(checkVersion(&settings, L"A"), false);
+        ASSERT_EQ(checkVersion(&settings, L"FOO"), false);
+        ASSERT_EQ(checkVersion(&settings, L"F5"), false);
+
+        strcpy_s(settings.header, 6, "5A!");
+        ASSERT_EQ(checkVersion(&settings, L"5"), false);
+        strcpy_s(settings.header, 6, "FOO");
+        ASSERT_EQ(checkVersion(&settings, L"5"), false);
+        strcpy_s(settings.header, 6, "");
+        ASSERT_EQ(checkVersion(&settings, L"5"), false);
+    }
+
+    TEST(SettingsTest, FindPath)
+    {
+        wchar_t path[MAX_PATH];
+        BOOL res = findPath(path);
+
+        ASSERT_EQ(res, true);
+    }
+
+    TEST(SettingsTest, ReadSettings)
+    {
+        SETTINGS settings = { 0 };
+        BOOL result;
+
+        result = readSettings(&settings, L"5", L"test1.DLOCK");
+        ASSERT_EQ(result, true);
+        ASSERT_EQ(strcmp(settings.header, "DLOCK"), 0);
+        ASSERT_EQ(settings.version, 5);
+        ASSERT_EQ(settings.minimize, false);
+        ASSERT_EQ(settings.foreground, false);
+        ASSERT_EQ(settings.borderless, false);
+        ASSERT_EQ(settings.fullScreen, false);
+    }
+
+    TEST(SettingsTest, WriteSettings)
+    {
+        BOOL result;
+
+        SETTINGS settings = {"DLOCK", 5, true, true, false, false};
+
+        result = writeSettings(settings, L"output.DLOCK");
+        ASSERT_EQ(result, true);
+
+        settings.version = 0;
+
+        result = writeSettings(settings, L"output.DLOCK");
+        ASSERT_EQ(result, false);
+
+        settings.version = 5;
+
+        strcpy_s(settings.header, 6, "FOOBA");
+
+        result = writeSettings(settings, L".\\output.DLOCK");
+        ASSERT_EQ(result, false);
+
+        DeleteFileW(L"output.DLOCK");
+    }
+}