Merge branch 'myk_unit_testing' into myk_ctest

.github/workflows/build.yml

@@ -83,7 +83,7 @@ jobs:
           -B build-ci \
           -G Ninja \
           -DDFHACK_BUILD_ARCH=64 \
-          -DBUILD_TESTING:BOOL=ON \
+          -DBUILD_TESTS:BOOL=ON \
           -DBUILD_DEV_PLUGINS:BOOL=${{ matrix.plugins == 'all' }} \
           -DBUILD_SIZECHECK:BOOL=${{ matrix.plugins == 'all' }} \
           -DBUILD_SKELETON:BOOL=${{ matrix.plugins == 'all' }} \
@@ -96,15 +96,13 @@ jobs:
       run: |
         ninja -C build-ci install
         ccache --show-stats
-    - name: Run unit tests
+    - name: Run cpp unit tests
-      id: run_tests1
+      id: run_tests_cpp
       run: |
-        if build-ci/library/tests/test-library; then
+        ninja -C build-ci test
-          exit 0
+        exit $?
-        fi
-        exit 1
     - name: Run lua tests
-      id: run_tests2
+      id: run_tests_lua
       run: |
         export TERM=dumb
         status=0

CMakeLists.txt

@@ -394,11 +394,10 @@ else()
     endif()
 endif()
 
-if(BUILD_TESTING)
+find_package(ZLIB REQUIRED)
-    message("BUILD TESTS: Core, Scripts")
+include_directories(depends/protobuf)
-    set(BUILD_SCRIPT_TESTS ON FORCE)
+include_directories(depends/lua/include)
-    set(BUILD_CORE_TESTS ON FORCE)
+include_directories(depends/md5)
-endif()
 
 # Support linking against external tinyxml
 # If we find an external tinyxml, set the DFHACK_TINYXML variable to "tinyxml"
@@ -415,11 +414,6 @@ else()
     set(DFHACK_TINYXML "dfhack-tinyxml")
 endif()
 
-find_package(ZLIB REQUIRED)
-
-include_directories(depends/protobuf)
-include_directories(depends/lua/include)
-include_directories(depends/md5)
 include_directories(depends/lodepng)
 include_directories(depends/tthread)
 include_directories(${ZLIB_INCLUDE_DIRS})
@@ -427,42 +421,16 @@ include_directories(depends/clsocket/src)
 include_directories(depends/xlsxio/include)
 add_subdirectory(depends)
 
-
 # Testing with CTest
-if(BUILD_TESTING OR BUILD_CORE_TESTS)
+macro(dfhack_test name files)
-    macro(dfhack_test name files)
+    message("dfhack_test(${name}, ${files})")
-        message("dfhack_test(${name}, ${files})")
+    add_executable(${name} ${files})
-        add_executable(${name} ${files})
+    target_include_directories(${name} PUBLIC depends/googletest/googletest/include)
-        target_include_directories(${name} PUBLIC depends/googletest/googletest/include)
+    target_link_libraries(${name} dfhack gtest)
-        target_link_libraries(${name} dfhack gtest)
+    set_target_properties(${name} PROPERTIES COMPILE_FLAGS "-Wno-sign-compare")
-        set_target_properties(${name} PROPERTIES COMPILE_FLAGS "-Wno-sign-compare")
+    add_test(NAME ${name} COMMAND ${name})
-        add_test(NAME ${name} COMMAND ${name})
+endmacro()
-    endmacro()
+include(CTest)
-    include(CTest)
-endif()
-
-include(CMakeDependentOption)
-cmake_dependent_option(
-        BUILD_SCRIPT_TESTS "Install integration tests in hack/scripts/test" OFF
-        "BUILD_TESTING" OFF)
-mark_as_advanced(FORCE BUILD_TESTS)
-# Handle deprecated BUILD_TESTS option
-option(BUILD_TESTS "Deprecated option; please use BUILD_SCRIPT_TESTS=ON" OFF)
-
-if(BUILD_TESTING OR BUILD_SCRIPT_TESTS)
-    if(EXISTS "${dfhack_SOURCE_DIR}/test/scripts")
-        message(SEND_ERROR "test/scripts must not exist in the dfhack repo since it would conflict with the tests installed from the scripts repo.")
-    endif()
-    install(DIRECTORY ${dfhack_SOURCE_DIR}/test
-            DESTINATION ${DFHACK_DATA_DESTINATION}/scripts)
-    install(FILES ci/test.lua DESTINATION ${DFHACK_DATA_DESTINATION}/scripts)
-else()
-    add_custom_target(test
-            COMMENT "Nothing to do: CMake option BUILD_TESTING is OFF"
-            # Portable NOOP; need to put something here or the comment isn't displayed
-            COMMAND cd
-            )
-endif()
 
 find_package(Git REQUIRED)
 if(NOT GIT_FOUND)
@@ -570,36 +538,14 @@ if(BUILD_DOCS)
     install(FILES "README.html" DESTINATION "${DFHACK_DATA_DESTINATION}")
 endif()
 
-# Testing with CTest
+option(BUILD_TESTS "Include tests (currently just installs Lua tests into the scripts folder)" OFF)
-include(CTest)
+if(BUILD_TESTS)
-
+    if(EXISTS "${dfhack_SOURCE_DIR}/test/scripts")
-include(CMakeDependentOption)
+        message(SEND_ERROR "test/scripts must not exist in the dfhack repo since it would conflict with the tests installed from the scripts repo.")
-cmake_dependent_option(
-    BUILD_TEST_SCRIPTS "Install integration tests in hack/scripts/test" OFF
-    "BUILD_TESTING" OFF)
-mark_as_advanced(FORCE BUILD_TESTS)
-
-# Handle deprecated BUILD_TESTS option
-option(BUILD_TESTS "Deprecated option; please use BUILD_TEST_SCRIPTS=ON" OFF)
-if(BUILD_TESTING AND BUILD_TESTS)
-    set(BUILD_TEST_SCRIPTS ON FORCE)
-endif()
-
-if(BUILD_TESTING)
-    if(BUILD_TEST_SCRIPTS)
-        if(EXISTS "${dfhack_SOURCE_DIR}/test/scripts")
-            message(SEND_ERROR "test/scripts must not exist in the dfhack repo since it would conflict with the tests installed from the scripts repo.")
-        endif()
-        install(DIRECTORY ${dfhack_SOURCE_DIR}/test
-            DESTINATION ${DFHACK_DATA_DESTINATION}/scripts)
-        install(FILES ci/test.lua DESTINATION ${DFHACK_DATA_DESTINATION}/scripts)
     endif()
-else()
+    install(DIRECTORY ${dfhack_SOURCE_DIR}/test
-    add_custom_target(test
+            DESTINATION ${DFHACK_DATA_DESTINATION}/scripts)
-        COMMENT "Nothing to do: CMake option BUILD_TESTS is OFF"
+    install(FILES ci/test.lua DESTINATION ${DFHACK_DATA_DESTINATION}/scripts)
-        # Portable NOOP; need to put something here or the comment isn't displayed
-        COMMAND cd
-    )
 endif()
 
 # Packaging with CPack!

data/CMakeLists.txt

@@ -21,7 +21,7 @@ install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/blueprints/
         FILES_MATCHING PATTERN "*"
                        PATTERN blueprints/library/test EXCLUDE)
 
-if(BUILD_SCRIPT_TESTS)
+if(BUILD_TESTS)
     install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/blueprints/library/test/
             DESTINATION blueprints/library/test
     )

depends/CMakeLists.txt

@@ -3,10 +3,8 @@ add_subdirectory(lodepng)
 add_subdirectory(lua)
 add_subdirectory(md5)
 add_subdirectory(protobuf)
-if(BUILD_CORE_TESTS)
+add_subdirectory(googletest)
-    add_subdirectory(googletest EXCLUDE_FROM_ALL)
+set_target_properties(gtest PROPERTIES COMPILE_FLAGS "-Wno-maybe-uninitialized -Wno-sign-compare")
-    set_target_properties(gtest PROPERTIES COMPILE_FLAGS "-Wno-maybe-uninitialized -Wno-sign-compare")
-endif()
 
 # Don't build tinyxml if it's being externally linked against.
 if(NOT TinyXML_FOUND)

docs/changelog.txt

@@ -44,6 +44,7 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
 - `automaterial`: fix rendering errors with box boundary markers
 - `autolabor` & `autohauler`: properly handle jobs 241, 242, and 243
 - `autofarm`: add missing output flushes
+- `hotkeys`: correctly detect hotkeys bound to number keys, F11, or F12
 - Core: fix the segmentation fault with the REPORT event in EventManager
 - Core: fix the new JOB_STARTED event only sending each event once, to the first handler listed
 - Core: ensure ``foo.init`` always runs before ``foo.*.init`` (e.g.  ``dfhack.init`` should always run before ``dfhack.something.init``)
@@ -60,6 +61,7 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
 - `ls`: indent tag listings and wrap them in the right column for better readability
 - `ls`: new ``--exclude`` option for hiding matched scripts from the output.  this can be especially useful for modders who don't want their mod scripts to be included in ``ls`` output.
 - `hotkeys`: hotkey screen has been transformed into an interactive `overlay` widget that you can bring up by moving the mouse cursor over the hotspot (in the upper left corner of the screen by default)
+- `hotkeys`: now supports printing active hotkeys to the console with ``hotkeys list``
 - `digtype`: new ``-z`` option for digtype to restrict designations to the current z-level and down
 - UX: List widgets now have mouse-interactive scrollbars
 - UX: You can now hold down the mouse button on a scrollbar to make it scroll multiple times.

library/CMakeLists.txt

@@ -82,9 +82,7 @@ set(MAIN_SOURCES
     RemoteTools.cpp
 )
 
-if(BUILD_CORE_TESTS)
+add_subdirectory(tests)
-    add_subdirectory(tests)
-endif()
 
 if(WIN32)
     set(CONSOLE_SOURCES Console-windows.cpp)

library/tests/CMakeLists.txt

@@ -1,7 +1,4 @@
-file(GLOB_RECURSE TEST_SOURCES LIST_DIRECTORIES false *test.cpp)
+file(GLOB_RECURSE TEST_SOURCES
+    LIST_DIRECTORIES false
+    *test.cpp)
 dfhack_test(test-library "${TEST_SOURCES}")
-
-# How to get `test` to ensure everything is up to date before running
-# tests? This add_dependencies() fails with:
-#   Cannot add target-level dependencies to non-existent target "test".
-#add_dependencies(test MiscUtils.test)

plugins/hotkeys.cpp

@@ -76,11 +76,15 @@ static void find_active_keybindings(df::viewscreen *screen, bool filtermenu) {
 
     vector<string> valid_keys;
 
+    for (char c = '0'; c <= '9'; c++) {
+        valid_keys.push_back(string(&c, 1));
+    }
+
     for (char c = 'A'; c <= 'Z'; c++) {
         valid_keys.push_back(string(&c, 1));
     }
 
-    for (int i = 1; i < 10; i++) {
+    for (int i = 1; i <= 12; i++) {
         valid_keys.push_back("F" + int_to_string(i));
     }