Prepare KHook for 1.0 release

.github/workflows/ci.yml

@@ -5,12 +5,14 @@ on:
     branches: [ master ]
   pull_request:
     branches: [ master ]
+  workflow_dispatch:
 
 jobs:
   build:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
+        arch: [x86, x86_64]
         include:
           - os: ubuntu-latest
             cc: clang
@@ -19,7 +21,7 @@ jobs:
             cc: msvc
       fail-fast: false
 
-    name: ${{ matrix.os }} - ${{ matrix.cc }}
+    name: ${{ matrix.os }} - ${{ matrix.cc }} (${{ matrix.arch }})
     runs-on: ${{ matrix.os }}
 
     steps:
@@ -42,26 +44,25 @@ jobs:
         run: |
           python -m pip install --upgrade pip setuptools wheel
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         name: Repository checkout
         with:
           fetch-depth: 0
           submodules: recursive
           path: repository
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         name: AMBuild checkout
         with:
           repository: alliedmodders/ambuild
-          ref: fe8c99ccd24fa926bf6ac6b9935a5fc03df06a72
+          ref: 25a23ac92307eb1e181fd3e7d9385412d4034532
           fetch-depth: 0
           submodules: recursive
           path: ambuild
 
       - name: Setup AMBuild
         shell: bash
         run: |
-          cd "${{ env.CACHE_PATH }}"
           python -m pip install ./ambuild
 
       - name: Select clang compiler
@@ -78,5 +79,11 @@ jobs:
         run: |
           mkdir build
           cd build
-          python ../configure.py
-          ambuild
+          python ../configure.py --targets ${{ matrix.arch }} --enable-tests
+          ambuild
+
+      - name: Test
+        shell: bash
+        working-directory: repository
+        run: |
+          python ./test.py --target ${{ matrix.arch }} --skip-build

.gitignore

@@ -0,0 +1,2 @@
+build/
+.vscode/

.gitmodules

@@ -1,3 +1,9 @@
 [submodule "third_party/safetyhook"]
 	path = third_party/safetyhook
 	url = https://github.com/alliedmodders/safetyhook
+[submodule "third_party/googletest"]
+	path = third_party/googletest
+	url = https://github.com/google/googletest.git
+[submodule "third_party/gtest-parallel"]
+	path = third_party/gtest-parallel
+	url = https://github.com/google/gtest-parallel.git

AMBuildScript

@@ -3,6 +3,9 @@ class KHook(object):
     self.all_targets = []
     self.libsafetyhook = {}
     self.libkhook = {}
+    self.libgtest = {}
+    self.test_binaries = []
+
   def configure(self):
     target_archs = []
     if builder.options.targets:
@@ -29,9 +32,17 @@ class KHook(object):
             cxx.cxxflags += [
                 '/std:c++17'
             ]
+        if getattr(builder.options, 'enable_tests', False):
+            cxx.defines += ['KHOOK_TESTS']
 
 
 KH = KHook()
 KH.configure()
 builder.Build('third_party/safetyhook/AMBuilder', {'SafetyHook': KH})
-builder.Build('AMBuilder', {'KHook': KH})
+builder.Build('AMBuilder', {'KHook': KH})
+
+if getattr(builder.options, 'enable_tests', False):
+  builder.Build('test/AMBuilder.gtest', {'GTest': KH})
+  builder.Build('test/AMBuilder', {'TestRunner': KH, 'KHook': KH, 'SafetyHook': KH})
+
+builder.Build('PackageScript', {'KHook': KH})

AMBuilder

@@ -8,7 +8,8 @@ def AddSourceFilesFromDir(path, files):
 
 libkhook = builder.StaticLibraryProject('khook')
 libkhook.sources = AddSourceFilesFromDir(os.path.join(builder.currentSourcePath, 'src'),[
-  "detour.cpp"
+  "detour.cpp",
+  "ranges.cpp"
 ])
 
 for compiler in KHook.all_targets:

PackageScript

@@ -0,0 +1,19 @@
+import os
+
+builder.SetBuildFolder('package')
+
+folder_list = [
+  'x86',
+  'x86_64'
+]
+
+folder_map = {}
+for folder in folder_list:
+  norm_folder = os.path.normpath(folder)
+  folder_map[folder] = builder.AddFolder(norm_folder)
+
+for cxx_task in KHook.test_binaries:
+  if cxx_task.target.arch == 'x86_64':
+    builder.AddCopy(cxx_task.binary, folder_map['x86_64'])
+  else:
+    builder.AddCopy(cxx_task.binary, folder_map['x86'])

README.md

@@ -90,4 +90,8 @@ All hooks can be configured through the use of the function `Configure`.
 
 ## Testing
 
-There is currently no test suite.
+The test suite uses the [GoogleTest](https://github.com/google/googletest) framework and can be built by configuring AMBuild with the `--enable-tests` flag. Tests must be executed in parallel with [gtest-parallel](https://github.com/google/gtest-parallel) in their own processes to avoid conflicts with each other.
+
+To execute the test suite, run the `test.py` script with the `--target` argument specifying the target architecture to test, `x86` for 32-bit or `x86_64` for 64-bit. For example, to test the 64-bit target, run `python test.py --target x86_64`. The script will handle building the tests and executing them in parallel.
+
+For more options, run `python test.py --help`.

configure.py

@@ -4,4 +4,6 @@
 parser = run.BuildParser(sourcePath = sys.path[0], api='2.2')
 parser.options.add_argument('--targets', type=str, dest='targets', default=None,
 		                help="Override the target architecture (use commas to separate multiple targets).")
+parser.options.add_argument('--enable-tests', default=False, dest='enable_tests', action='store_true',
+                       help='Build tests.')
 parser.Configure()