KBM - Set up tests for keyboard hook remapping logic (#4004)

* Add test proj, refactor proj with filters, and move single remap function to a separate header * Moved all methods to header files * remove more unused commented code * Reverted sln file * Fixed sln file * Added interface wrapping SendInput calls * fixed formatting * Created test mock class * Added keyboard input logic * Fixed compilation errors and added nuget reference to CppWinRT * Added tests for single key remapping * Refactored code for adding shortcut remap tests * Separated test classes * Fixed tests in release mode * Added more tests * Resolved comments
2026-04-03 17:56:44 +02:00 · 2020-06-11 13:07:46 -07:00
parent 670033c4da
commit 071ea1dc97
30 changed files with 1866 additions and 66 deletions
--- a/src/modules/keyboardmanager/test/KeyboardManagerRemapLogicTest.cpp
+++ b/src/modules/keyboardmanager/test/KeyboardManagerRemapLogicTest.cpp
--- a/src/modules/keyboardmanager/test/KeyboardManagerTest.vcxproj
+++ b/src/modules/keyboardmanager/test/KeyboardManagerTest.vcxproj
@@ -0,0 +1,140 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <Import Project="..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.200602.3\build\native\Microsoft.Windows.CppWinRT.props" Condition="Exists('..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.200602.3\build\native\Microsoft.Windows.CppWinRT.props')" />
+  <ItemGroup Label="ProjectConfigurations">
+    <ProjectConfiguration Include="Debug|x64">
+      <Configuration>Debug</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release|x64">
+      <Configuration>Release</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+  </ItemGroup>
+  <PropertyGroup Label="Globals">
+    <VCProjectVersion>16.0</VCProjectVersion>
+    <ProjectGuid>{62173D9A-6724-4C00-A1C8-FB646480A9EC}</ProjectGuid>
+    <Keyword>Win32Proj</Keyword>
+    <RootNamespace>KeyboardManagerTest</RootNamespace>
+    <WindowsTargetPlatformVersion>10.0.18362.0</WindowsTargetPlatformVersion>
+    <ProjectSubType>NativeUnitTestProject</ProjectSubType>
+  </PropertyGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
+    <ConfigurationType>DynamicLibrary</ConfigurationType>
+    <UseDebugLibraries>true</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <CharacterSet>Unicode</CharacterSet>
+    <SpectreMitigation>Spectre</SpectreMitigation>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
+    <ConfigurationType>DynamicLibrary</ConfigurationType>
+    <UseDebugLibraries>false</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <WholeProgramOptimization>true</WholeProgramOptimization>
+    <CharacterSet>Unicode</CharacterSet>
+    <SpectreMitigation>Spectre</SpectreMitigation>
+  </PropertyGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
+  <ImportGroup Label="ExtensionSettings">
+  </ImportGroup>
+  <ImportGroup Label="Shared">
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <PropertyGroup Label="UserMacros" />
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <LinkIncremental>true</LinkIncremental>
+    <OutDir>$(SolutionDir)$(Platform)\$(Configuration)\modules\KeyboardManager\</OutDir>
+    <IntDir>$(Platform)\$(Configuration)\obj\$(ProjectName)\</IntDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <LinkIncremental>false</LinkIncremental>
+    <OutDir>$(SolutionDir)$(Platform)\$(Configuration)\modules\KeyboardManager\</OutDir>
+    <IntDir>$(Platform)\$(Configuration)\obj\$(ProjectName)\</IntDir>
+  </PropertyGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <SDLCheck>true</SDLCheck>
+      <AdditionalIncludeDirectories>$(VCInstallDir)UnitTest\include;$(SolutionDir)src\;$(SolutionDir)src\modules;$(SolutionDir)src\common\Telemetry;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <PreprocessorDefinitions>_DEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <UseFullPaths>true</UseFullPaths>
+      <TreatWarningAsError>true</TreatWarningAsError>
+      <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
+      <DisableSpecificWarnings>4002</DisableSpecificWarnings>
+    </ClCompile>
+    <Link>
+      <SubSystem>Windows</SubSystem>
+      <AdditionalLibraryDirectories>$(VCInstallDir)UnitTest\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <FunctionLevelLinking>true</FunctionLevelLinking>
+      <IntrinsicFunctions>true</IntrinsicFunctions>
+      <SDLCheck>true</SDLCheck>
+      <AdditionalIncludeDirectories>$(VCInstallDir)UnitTest\include;$(SolutionDir)src\;$(SolutionDir)src\modules;$(SolutionDir)src\common\Telemetry;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <PreprocessorDefinitions>NDEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <UseFullPaths>true</UseFullPaths>
+      <TreatWarningAsError>true</TreatWarningAsError>
+      <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
+      <DisableSpecificWarnings>4002</DisableSpecificWarnings>
+    </ClCompile>
+    <Link>
+      <SubSystem>Windows</SubSystem>
+      <EnableCOMDATFolding>true</EnableCOMDATFolding>
+      <OptimizeReferences>true</OptimizeReferences>
+      <AdditionalLibraryDirectories>$(VCInstallDir)UnitTest\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(CIBuild)'!='true'">
+    <ClCompile>
+      <PrecompiledHeader>Use</PrecompiledHeader>
+      <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
+    </ClCompile>
+  </ItemDefinitionGroup>
+  <ItemGroup>
+    <ClCompile Include="KeyboardManagerRemapLogicTest.cpp" />
+    <ClCompile Include="MockedInput.cpp" />
+    <ClCompile Include="pch.cpp">
+      <PrecompiledHeader Condition="'$(CIBuild)'!='true'">Create</PrecompiledHeader>
+    </ClCompile>
+    <ClCompile Include="TestHelpers.cpp" />
+  </ItemGroup>
+  <ItemGroup>
+    <ClInclude Include="MockedInput.h" />
+    <ClInclude Include="pch.h" />
+    <ClInclude Include="TestHelpers.h" />
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\common\KeyboardManagerCommon.vcxproj">
+      <Project>{8affa899-0b73-49ec-8c50-0fadda57b2fc}</Project>
+    </ProjectReference>
+    <ProjectReference Include="..\dll\KeyboardManager.vcxproj">
+      <Project>{89f34af7-1c34-4a72-aa6e-534bcf972bd9}</Project>
+    </ProjectReference>
+    <ProjectReference Include="..\ui\KeyboardManagerUI.vcxproj">
+      <Project>{eaf23649-ef6e-478b-980e-81fad96cca2a}</Project>
+    </ProjectReference>
+  </ItemGroup>
+  <ItemGroup>
+    <None Include="packages.config" />
+  </ItemGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
+  <ImportGroup Label="ExtensionTargets">
+    <Import Project="..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.200602.3\build\native\Microsoft.Windows.CppWinRT.targets" Condition="Exists('..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.200602.3\build\native\Microsoft.Windows.CppWinRT.targets')" />
+  </ImportGroup>
+  <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.200602.3\build\native\Microsoft.Windows.CppWinRT.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.200602.3\build\native\Microsoft.Windows.CppWinRT.props'))" />
+    <Error Condition="!Exists('..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.200602.3\build\native\Microsoft.Windows.CppWinRT.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\..\packages\Microsoft.Windows.CppWinRT.2.0.200602.3\build\native\Microsoft.Windows.CppWinRT.targets'))" />
+  </Target>
+</Project>
--- a/src/modules/keyboardmanager/test/KeyboardManagerTest.vcxproj.filters
+++ b/src/modules/keyboardmanager/test/KeyboardManagerTest.vcxproj.filters
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ItemGroup>
+    <Filter Include="Source Files">
+      <UniqueIdentifier>{4FC737F1-C7A5-4376-A066-2A32D752A2FF}</UniqueIdentifier>
+      <Extensions>cpp;c;cc;cxx;c++;def;odl;idl;hpj;bat;asm;asmx</Extensions>
+    </Filter>
+    <Filter Include="Header Files">
+      <UniqueIdentifier>{93995380-89BD-4b04-88EB-625FBE52EBFB}</UniqueIdentifier>
+      <Extensions>h;hh;hpp;hxx;h++;hm;inl;inc;ipp;xsd</Extensions>
+    </Filter>
+    <Filter Include="Resource Files">
+      <UniqueIdentifier>{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}</UniqueIdentifier>
+      <Extensions>rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms</Extensions>
+    </Filter>
+  </ItemGroup>
+  <ItemGroup>
+    <ClCompile Include="pch.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
+    <ClCompile Include="MockedInput.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
+    <ClCompile Include="TestHelpers.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
+    <ClCompile Include="KeyboardManagerRemapLogicTest.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
+  </ItemGroup>
+  <ItemGroup>
+    <ClInclude Include="pch.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="MockedInput.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="TestHelpers.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+  </ItemGroup>
+  <ItemGroup>
+    <None Include="packages.config" />
+  </ItemGroup>
+</Project>
--- a/src/modules/keyboardmanager/test/MockedInput.cpp
+++ b/src/modules/keyboardmanager/test/MockedInput.cpp
@@ -0,0 +1,130 @@
+#include "pch.h"
+#include "MockedInput.h"
+
+// Set the keyboard hook procedure to be tested
+void MockedInput::SetHookProc(std::function<intptr_t(LowlevelKeyboardEvent*)> hookProcedure)
+{
+    hookProc = hookProcedure;
+}
+
+// Function to simulate keyboard input - arguments and return value based on SendInput function (https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-sendinput)
+UINT MockedInput::SendVirtualInput(UINT cInputs, LPINPUT pInputs, int cbSize)
+{
+    // Iterate over inputs
+    for (UINT i = 0; i < cInputs; i++)
+    {
+        LowlevelKeyboardEvent keyEvent;
+
+        // Distinguish between key and sys key by checking if the key is either F10 (for syskeydown) or if the key message is sent while Alt is held down. SYSKEY messages are also sent if there is no window in focus, but that has not been mocked since it would require many changes. More details on key messages at https://docs.microsoft.com/en-us/windows/win32/inputdev/wm-syskeydown
+        if (pInputs[i].ki.dwFlags & KEYEVENTF_KEYUP)
+        {
+            if (keyboardState[VK_MENU] == true)
+            {
+                keyEvent.wParam = WM_SYSKEYUP;
+            }
+            else
+            {
+                keyEvent.wParam = WM_KEYUP;
+            }
+        }
+        else
+        {
+            if (pInputs[i].ki.wVk == VK_F10 || keyboardState[VK_MENU] == true)
+            {
+                keyEvent.wParam = WM_SYSKEYDOWN;
+            }
+            else
+            {
+                keyEvent.wParam = WM_KEYDOWN;
+            }
+        }
+        KBDLLHOOKSTRUCT lParam = {};
+
+        // Set only vkCode and dwExtraInfo since other values are unused
+        lParam.vkCode = pInputs[i].ki.wVk;
+        lParam.dwExtraInfo = pInputs[i].ki.dwExtraInfo;
+        keyEvent.lParam = &lParam;
+
+        // Call low level hook handler
+        intptr_t result = MockedKeyboardHook(&keyEvent);
+
+        // Set keyboard state if the hook does not suppress the input
+        if (result == 0)
+        {
+            // If key up flag is set, then set keyboard state to false
+            keyboardState[pInputs[i].ki.wVk] = (pInputs[i].ki.dwFlags & KEYEVENTF_KEYUP) ? false : true;
+
+            // Handling modifier key codes
+            switch (pInputs[i].ki.wVk)
+            {
+            case VK_CONTROL:
+                if (pInputs[i].ki.dwFlags & KEYEVENTF_KEYUP)
+                {
+                    keyboardState[VK_LCONTROL] = false;
+                    keyboardState[VK_RCONTROL] = false;
+                    break;
+                }
+            case VK_LCONTROL:
+                keyboardState[VK_CONTROL] = (pInputs[i].ki.dwFlags & KEYEVENTF_KEYUP) ? false : true;
+                break;
+            case VK_RCONTROL:
+                keyboardState[VK_CONTROL] = (pInputs[i].ki.dwFlags & KEYEVENTF_KEYUP) ? false : true;
+                break;
+            case VK_MENU:
+                if (pInputs[i].ki.dwFlags & KEYEVENTF_KEYUP)
+                {
+                    keyboardState[VK_LMENU] = false;
+                    keyboardState[VK_RMENU] = false;
+                    break;
+                }
+            case VK_LMENU:
+                keyboardState[VK_MENU] = (pInputs[i].ki.dwFlags & KEYEVENTF_KEYUP) ? false : true;
+                break;
+            case VK_RMENU:
+                keyboardState[VK_MENU] = (pInputs[i].ki.dwFlags & KEYEVENTF_KEYUP) ? false : true;
+                break;
+            case VK_SHIFT:
+                if (pInputs[i].ki.dwFlags & KEYEVENTF_KEYUP)
+                {
+                    keyboardState[VK_LSHIFT] = false;
+                    keyboardState[VK_RSHIFT] = false;
+                    break;
+                }
+            case VK_LSHIFT:
+                keyboardState[VK_SHIFT] = (pInputs[i].ki.dwFlags & KEYEVENTF_KEYUP) ? false : true;
+                break;
+            case VK_RSHIFT:
+                keyboardState[VK_SHIFT] = (pInputs[i].ki.dwFlags & KEYEVENTF_KEYUP) ? false : true;
+                break;
+            }
+        }
+    }
+
+    return cInputs;
+}
+
+// Function to simulate keyboard hook behavior
+intptr_t MockedInput::MockedKeyboardHook(LowlevelKeyboardEvent* data)
+{
+    // If the hookProc is set to null, then skip the hook
+    if (hookProc != nullptr)
+    {
+        return hookProc(data);
+    }
+    else
+    {
+        return 0;
+    }
+}
+
+// Function to get the state of a particular key
+bool MockedInput::GetVirtualKeyState(int key)
+{
+    return keyboardState[key];
+}
+
+// Function to reset the mocked keyboard state
+void MockedInput::ResetKeyboardState()
+{
+    std::fill(keyboardState.begin(), keyboardState.end(), false);
+}
--- a/src/modules/keyboardmanager/test/MockedInput.h
+++ b/src/modules/keyboardmanager/test/MockedInput.h
@@ -0,0 +1,38 @@
+#pragma once
+#include <keyboardmanager/common/InputInterface.h>
+#include <vector>
+#include <functional>
+#include <interface/lowlevel_keyboard_event_data.h>
+
+// Class for mocked keyboard input
+class MockedInput :
+    public InputInterface
+{
+private:
+    // Stores the states for all the keys - false for key up, and true for key down
+    std::vector<bool> keyboardState;
+
+    // Function to be executed as a low level hook. By default it is nullptr so the hook is skipped
+    std::function<intptr_t(LowlevelKeyboardEvent*)> hookProc;
+
+public:
+    MockedInput()
+    {
+        keyboardState.resize(256, false);
+    }
+
+    // Set the keyboard hook procedure to be tested
+    void SetHookProc(std::function<intptr_t(LowlevelKeyboardEvent*)> hookProcedure);
+
+    // Function to simulate keyboard input
+    UINT SendVirtualInput(UINT cInputs, LPINPUT pInputs, int cbSize);
+
+    // Function to simulate keyboard hook behavior
+    intptr_t MockedKeyboardHook(LowlevelKeyboardEvent* data);
+
+    // Function to get the state of a particular key
+    bool GetVirtualKeyState(int key);
+
+    // Function to reset the mocked keyboard state
+    void ResetKeyboardState();
+};
--- a/src/modules/keyboardmanager/test/TestHelpers.cpp
+++ b/src/modules/keyboardmanager/test/TestHelpers.cpp
@@ -0,0 +1,14 @@
+#include "pch.h"
+#include "TestHelpers.h"
+
+namespace TestHelpers
+{
+    // Function to reset the environment variables for tests
+    void ResetTestEnv(MockedInput& input, KeyboardManagerState& state)
+    {
+        input.ResetKeyboardState();
+        input.SetHookProc(nullptr);
+        state.ClearSingleKeyRemaps();
+        state.ClearOSLevelShortcuts();
+    }
+}
--- a/src/modules/keyboardmanager/test/TestHelpers.h
+++ b/src/modules/keyboardmanager/test/TestHelpers.h
@@ -0,0 +1,9 @@
+#pragma once
+#include "MockedInput.h"
+#include <keyboardmanager/common/KeyboardManagerState.h>
+
+namespace TestHelpers
+{
+    // Function to reset the environment variables for tests
+    void ResetTestEnv(MockedInput& input, KeyboardManagerState& state);
+}
--- a/src/modules/keyboardmanager/test/packages.config
+++ b/src/modules/keyboardmanager/test/packages.config
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<packages>
+  <package id="Microsoft.Windows.CppWinRT" version="2.0.200602.3" targetFramework="native" />
+</packages>
--- a/src/modules/keyboardmanager/test/pch.cpp
+++ b/src/modules/keyboardmanager/test/pch.cpp
@@ -0,0 +1,5 @@
+// pch.cpp: source file corresponding to the pre-compiled header
+
+#include "pch.h"
+
+// When you are using pre-compiled headers, this source file is necessary for compilation to succeed.
--- a/src/modules/keyboardmanager/test/pch.h
+++ b/src/modules/keyboardmanager/test/pch.h
@@ -0,0 +1 @@
+#pragma once