Merge pull request #630 from GameTechDev/tests/fix-timing-sysdep

Merge testing enhancements, related bugfixes, etc.

Author: planetchili

.gitignore

@@ -68,5 +68,6 @@ PresentMon/ddETWExternalEventsTEMP.BIN
 
 # Local runsettings files (user-specific test configurations)
 *.local.runsettings
+machine_expectations.json
 
 Directory.Build.props

BUILDING.md

@@ -4,66 +4,36 @@
 
 - Visual Studio 2022
 
+- [vcpkg](https://github.com/microsoft/vcpkg)
+
 - [CMake](https://cmake.org)
 
 - [Node.js / NPM](https://nodejs.org/en/download)
 
-- [v3 of the WiX toolset and VS extension](https://wixtoolset.org/docs/wix3/)
+- [v3 of the WiX toolset AND VS extension](https://wixtoolset.org/docs/wix3/)
 
 Note: if you only want to build the PresentData library, or the PresentMon Console application
 you only need Visual Studio.  Ignore the other build and source dependency instructions and build
 `PresentData\PresentData.vcxproj` or `PresentMon\ConsoleApplication.sln`.
 
 ## Install Source Dependencies
 
-1. Download and install *vcpkg*, which will be used to obtain source package dependencies during the build:
+1. Run the repository bootstrap script:
 
-    ```bat
+    ```powershell
     > cd PresentMonRepoDir
-    > git clone https://github.com/Microsoft/vcpkg.git build\vcpkg
-    > build\vcpkg\bootstrap-vcpkg.bat
-    > build\vcpkg\vcpkg.exe integrate install
-    > build\vcpkg\vcpkg.exe install
+    > .\bootstrap.ps1
     ```
 
-2. Build the Chromium Embedded Framework (CEF)
-
-    1. Download the CEF distribution and extract it to a local folder (e.g. C:\cef_133): https://cef-builds.spotifycdn.com/index.html
-
-        - Most recently tested release is version 136
-
-        - Proximal versions will most likely be compatible, but are not officially supported.
-
-        - The "Minimal Distribution" is sufficient.
-
-    2. Build 64-bit Debug and Release configurations (replace "CefDir" with the full path to the directory you downloaded into):
+    The bootstrap script:
 
-        ```bat
-        > cmake -G "Visual Studio 17" -A x64 -DUSE_SANDBOX=OFF -S CefDir -B CefDir\build
-        > cmake --build CefDir\build --config Debug
-        > cmake --build CefDir\build --config Release
-        ```
+    - Restores the locked Chromium Embedded Framework (CEF) payload.
+    - Pulls the pinned auxiliary test data.
+    - Installs and builds the AppCef web UI.
 
-    3. Copy the required build outputs into AppCef by running the following:
+    See the detailed guides for [CEF lock management](IntelPresentMon/AppCef/ceflock.md), [AppCef web UI setup](IntelPresentMon/AppCef/webui.md), and [auxiliary test data](Tests/auxdata.md).
 
-        ```bat
-        > IntelPresentMon\AppCef\Batch\pull-cef.bat CefDir
-        ```
-
-    4. You can now delete the local cef directory if you wish.
-
-3. Download and build the web asset dependencies via NPM.  This only needs to be run once on fresh clone, or after new packages are added:
-
-    ```bat
-    > pushd IntelPresentMon\AppCef\ipm-ui-vue
-    > npm ci
-    > npm run build
-    > popd
-    ```
-
-    Note: instead of using the production build as described above, you can use a development process with a local server with hotloading support.  To do this, use `npm run dev` instead, and use the `--ui-option url "http://localhost:5173/"` command line argument when running the *PresentMon Capture Application*.  This causes the app to load web content from localhost rather than the files in ipm-ui-vue/.
-
-4. Create and install a trusted test certificate.  This is only required for the Release build.  Open a command shell as administrator and run the following:
+2. Create and install a trusted test certificate.  This is only required for the Release build.  Open a command shell as administrator and run the following:
 
     ```bat
     > makecert -r -pe -n "CN=Test Certificate - For Internal Use Only" -ss PrivateCertStore testcert.cer
@@ -80,13 +50,21 @@ Build `PresentMon.sln` in Visual Studio or msbuild.  e.g.:
 
 ## Running PresentMon
 
-- PresentMon Console Application: `build\Release\PresentMon-dev-x64.exe`
+### Intel PresentMon
+
+Intel PresentMon is the UI application, `PresentMon.exe`.
+
+For Debug builds, the easiest IDE workflow is to set `Client/KernelProcess` as the startup project and launch `PresentMon.exe` with the service running as a child process:
 
-- PresentMon Console Tests: `build\Release\PresentMonTests-dev-x64.exe`
+```bat
+> --svc-as-child --files-working --log-level verbose --middleware-dll-path .\PresentMonAPI2.dll --log-middleware-copy
+```
 
-- PresentMon Service Command Line Interface: `build\Release\PresentMonCli.exe`
+For Release builds, either move the full Release output payload to a secure directory such as "Program Files" or "System32", or disable the secure directory check for local development. You cannot run release builds from the IDE typically. The installer is often the easier path for Release validation:
 
-- PresentMon Installer: `build\Release\en-us\PresentMon.msi`
+```bat
+> build\Release\en-us\PresentMon.msi
+```
 
 ### PresentMon Service
 
@@ -104,34 +82,26 @@ When you are finished, stop and remove the service with:
 > sc.exe delete PresentMonService
 ```
 
-### PresentMon Capture Application
+### PresentMon Standalone Console
 
-You must run the PresentMon Capture Application from its directory, with the *PresentMon Service* already running.  e.g.:
+The standalone console application is `PresentMon-dev-x64.exe`:
 
 ```bat
-> cd build\Debug
-> PresentMon.exe
+> build\Release\PresentMon-dev-x64.exe
 ```
 
-Further, for the Release build, the application must be run from a secure location (e.g. "Program Files" or "System32") so it will need to be copied there first. The Release build also cannot be started from Visual Studio, irregardless of whether the debugger is attached, and even if VS is running with admin privilege.
 
 ## Troubleshooting
 
-- If you are seeing vcpkg errors when updating to a new version of PresentMon (e.g., "error: while checking out baseline from commit...") then try updating or removing and re-adding vcpkg:
+- If you are seeing vcpkg errors when updating to a new version of PresentMon (e.g., "error: while checking out baseline from commit...") then try updating your vcpkg checkout.
+
+- Make sure vcpkg is using the same Visual Studio installation as the solution build. If needed, set `VCPKG_VISUAL_STUDIO_PATH` before running vcpkg.
 
-    ```bat
-    > cd PresentMonRepoDir
-    > build\vcpkg\vcpkg.exe remove
-    > build\vcpkg\vcpkg.exe integrate remove
-    > rmdir /s /q build\vcpkg
-    > git clone https://github.com/Microsoft/vcpkg.git build\vcpkg
-    > build\vcpkg\bootstrap-vcpkg.bat
-    > build\vcpkg\vcpkg.exe integrate install
-    > build\vcpkg\vcpkg.exe install
-    ```
 
 - If you get an error dialog from PresentMon.exe stating "A referral was returned form the server."
   you most likely do not have the certificate that the PresentMon service was signed with installed
-  into your trusted root.  Ensure that the above step 4 completed successfully.  If you built the
-  installer on another PC or received it from a trusted third party, you need to install the
-  certificate on the target PC as well.
+  into your trusted root.  Ensure that the trusted test certificate setup completed successfully.  If
+  you built the installer on another PC or received it from a trusted third party, you need to
+  install the certificate on the target PC as well.
+
+- Add the development user to the Performance Log Users group to run from the IDE, run tests, etc. without launching the IDE as administrator.

IntelPresentMon/AppCef/Batch/cef-build-wrapper.ps1

@@ -16,7 +16,10 @@
 
 param(
     [Parameter(Mandatory=$true, Position=0)]
-    [string]$RedistPath
+    [string]$RedistPath,
+
+    [Parameter()]
+    [switch]$Clean
 )
 
 # Resolve & verify
@@ -27,12 +30,23 @@ if (-not (Test-Path $RedistPath -PathType Container)) {
     Write-Error "Not a valid directory: $RedistPath"; exit 1
 }
 
-# Skip if already built
+# Skip if already built, unless the caller requested a clean wrapper build.
 $buildDir = Join-Path $RedistPath "build"
 if (Test-Path $buildDir) {
-    Write-Host "Found existing build directory: $buildDir"
-    Write-Host "→ Skipping configuration & build."
-    exit 0
+    if ($Clean) {
+        $resolvedBuildDir = (Resolve-Path $buildDir).ProviderPath
+        $resolvedRedistPath = (Resolve-Path $RedistPath).ProviderPath
+        if (-not $resolvedBuildDir.StartsWith($resolvedRedistPath, [System.StringComparison]::OrdinalIgnoreCase)) {
+            Write-Error "Refusing to clean unexpected build directory: $resolvedBuildDir"
+            exit 1
+        }
+        Write-Host "Removing existing CEF wrapper build directory: $buildDir"
+        Remove-Item -LiteralPath $buildDir -Recurse -Force
+    } else {
+        Write-Host "Found existing build directory: $buildDir"
+        Write-Host "Skipping configuration and build."
+        exit 0
+    }
 }
 
 # Locate VS / vcvarsall
@@ -56,25 +70,25 @@ $Generator = "Visual Studio 17"
 $Solution  = Join-Path $buildDir "cef.sln"
 
 # 1) Configure with CMake (no vcvars needed)
-Write-Host "→ Running CMake configure..."
+Write-Host "Running CMake configure..."
 cmake -G "$Generator" -A $Platform -DUSE_SANDBOX=OFF "$RedistPath"
 if ($LASTEXITCODE -ne 0) {
     Write-Error "CMake configuration failed (exit code $LASTEXITCODE)"; Pop-Location; exit $LASTEXITCODE
 }
 
 # 2) Build Release
-Write-Host "`n→ Building Release..."
+Write-Host "`nBuilding Release..."
 & cmd.exe /c "`"$vcvars`" $Arch && msbuild `"$Solution`" /m /p:Configuration=Release;Platform=$Platform"
 if ($LASTEXITCODE -ne 0) {
     Write-Error "Release build failed (exit code $LASTEXITCODE)"; Pop-Location; exit $LASTEXITCODE
 }
 
 # 3) Build Debug
-Write-Host "`n→ Building Debug..."
+Write-Host "`nBuilding Debug..."
 & cmd.exe /c "`"$vcvars`" $Arch && msbuild `"$Solution`" /m /p:Configuration=Debug;Platform=$Platform"
 if ($LASTEXITCODE -ne 0) {
     Write-Error "Debug build failed (exit code $LASTEXITCODE)"; Pop-Location; exit $LASTEXITCODE
 }
 
 Pop-Location
-Write-Host "`n✅ All done: CEF wrapper built in $buildDir"
+Write-Host "`nAll done: CEF wrapper built in $buildDir"