Merge pull request #508 from GameTechDev/pmc-ult-updates

PM Console ULT improvements

Author: planetchili

.gitignore

@@ -57,3 +57,6 @@ PresentMon/ddETWExternalEvents.h
 PresentMon/ddETWExternalEvents.rc
 
 PresentMon/ddETWExternalEventsTEMP.BIN
+
+# Local runsettings files (user-specific test configurations)
+*.local.runsettings

Tests/PresentMonTests.cpp

@@ -135,6 +135,18 @@ int wmain(
 {
     // Set defaults
     std::wstring goldDir(L"../../Tests/Gold");
+    
+    // Check for additional test directory from environment variable
+    // This allows developers to specify their own test directories without
+    // modifying the source code. Set PRESENTMON_ADDITIONAL_TEST_DIR environment
+    // variable or use a .runsettings.user file (see template).
+    std::wstring additionalTestDir;
+    wchar_t* envTestDir = nullptr;
+    size_t envTestDirLen = 0;
+    if (_wdupenv_s(&envTestDir, &envTestDirLen, L"PRESENTMON_ADDITIONAL_TEST_DIR") == 0 && envTestDir != nullptr) {
+        additionalTestDir = envTestDir;
+        free(envTestDir);
+    }
 
     {
         // If exe == <dir>/PresentMonTests-<ver>-<platform>.exe use
@@ -198,6 +210,7 @@ int wmain(
                 "options:\n"
                 "    --presentmon=path    Path to the PresentMon exe path to test (default=%ls).\n"
                 "    --golddir=path       Path to directory of test ETLs and gold CSVs (default=%ls).\n"
+                "    --opttestdir=path    Optional additional directory of test ETLs and gold CSVs.\n"
                 "    --outdir=path        Path to directory for test outputs (default=%%temp%%/PresentMonTestOutput).\n"
                 "    --nodelete           Keep the output directory after tests.\n"
                 "    --nowarnmissing      Don't warn if a found ETL is missing a gold CSV.\n"
@@ -221,6 +234,7 @@ int wmain(
     // Parse remaining command line arguments for custom commands.
     wchar_t* presentMonPathArg = nullptr;
     wchar_t* goldDirArg = nullptr;
+    wchar_t* optTestDirArg = nullptr;
     wchar_t* outDirArg = nullptr;
     bool deleteOutDir = true;
     for (int i = 1; i < argc; ++i) {
@@ -234,6 +248,11 @@ int wmain(
             continue;
         }
 
+        if (_wcsnicmp(argv[i], L"--opttestdir=", 10) == 0) {
+            optTestDirArg = argv[i] + 13;
+            continue;
+        }
+
         if (_wcsnicmp(argv[i], L"--outdir=", 9) == 0) {
             outDirArg = argv[i] + 9;
             continue;
@@ -267,9 +286,18 @@ int wmain(
     // Check command line arguments...
     bool goldDirExists = true;
     bool outDirExists = true;
+    std::wstring optTestDir;
+    bool optTestDirExists = false;
+    bool hasOptTestDir = optTestDirArg != nullptr;
+    
+    if (hasOptTestDir) {
+        optTestDir = optTestDirArg;
+    }
+    
     if (!CheckPath("--presentmon", &PresentMon::exePath_, presentMonPathArg, false, nullptr) ||
         !CheckPath("--golddir", &goldDir, goldDirArg, true, &goldDirExists) ||
-        !CheckPath("--outdir", &outDir_, outDirArg, true, &outDirExists)) {
+        !CheckPath("--outdir", &outDir_, outDirArg, true, &outDirExists) ||
+        (hasOptTestDir && !CheckPath("--opttestdir", &optTestDir, optTestDirArg, true, &optTestDirExists))) {
         return 1;
     }
 
@@ -281,6 +309,39 @@ int wmain(
         fprintf(stderr, "         using the --golddir command line argument.\n");
     }
 
+    // Add tests from optional test directory if specified (command line)
+    if (hasOptTestDir) {
+        printf("INFO: Using optional test directory from command line: %ls\n", optTestDir.c_str());
+        if (optTestDirExists) {
+            printf("INFO: Adding tests from test directory: %ls\n", optTestDir.c_str());
+            AddGoldEtlCsvTests(optTestDir, optTestDir.size());
+        } else {
+            fprintf(stderr, "warning: optional test directory does not exist: %ls\n", optTestDir.c_str());
+            fprintf(stderr, "         Continuing, but no tests from this directory will run.\n");
+        }
+    }
+    
+    // Add tests from additional test directory (environment variable)
+    if (!additionalTestDir.empty()) {
+        printf("INFO: Using additional test directory from environment: %ls\n", additionalTestDir.c_str());
+        // Ensure directory ends with backslash
+        if (additionalTestDir.back() != L'\\') {
+            additionalTestDir += L'\\';
+        }
+        
+        auto attr = GetFileAttributes(additionalTestDir.c_str());
+        if (attr != INVALID_FILE_ATTRIBUTES && (attr & FILE_ATTRIBUTE_DIRECTORY)) {
+            printf("INFO: Adding tests from additional directory: %ls\n", additionalTestDir.c_str());
+            AddGoldEtlCsvTests(additionalTestDir, additionalTestDir.size());
+        } else {
+            fprintf(stderr, "warning: additional test directory does not exist: %ls\n", additionalTestDir.c_str());
+        }
+    }
+    
+    if (!hasOptTestDir && additionalTestDir.empty()) {
+        printf("INFO: No optional test directories specified.\n");
+    }
+
     if (outDirExists) {
         if (deleteOutDir) {
             fprintf(stderr, "warning: output directory already exists: %ls\n", outDir_.c_str());

Tests/PresentMonTests.runsettings.template

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- 
+  Copy this file to PresentMonTests.local.runsettings and modify the path below
+  to point to your local test directory containing ETL and CSV files.
+  
+  The .local.runsettings file is ignored by git, so your local paths won't be committed.
+-->
+<RunSettings>
+  <RunConfiguration>
+    <TargetPlatform>x64</TargetPlatform>
+    <EnvironmentVariables>
+      <!-- Set this to your local test directory path -->
+      <PRESENTMON_ADDITIONAL_TEST_DIR>C:\path\to\your\test\directory</PRESENTMON_ADDITIONAL_TEST_DIR>
+    </EnvironmentVariables>
+  </RunConfiguration>
+  
+  <GoogleTestAdapterSettings>
+    <PrintTestOutput>true</PrintTestOutput>
+  </GoogleTestAdapterSettings>
+</RunSettings>

Tests/README.md

@@ -46,3 +46,43 @@ The following expected cases are currently missing (WIP):
 - PresentMode==Hardware_Legacy_Copy_To_Front_Buffer
 - [2,17-23] All Windows7 paths
 - [30] Non-Win7 Microsoft_Windows_Dwm_Core::FlipChain_(Pending|Complete|Dirty) with previous Microsoft_Windows_Dwm_Core::PresentHistory[Detailed]::Start
+
+## Adding Custom Test Directories
+
+To add your own test directory with ETL files and gold CSV files:
+
+### Method 1: Using local runsettings file (Recommended)
+
+1. Copy `PresentMonTests.runsettings.template` to `PresentMonTests.local.runsettings`
+2. Edit the `PRESENTMON_ADDITIONAL_TEST_DIR` path to point to your test directory
+3. In Visual Studio, go to **Test** → **Configure Run Settings** → **Select Solution Wide runsettings File**
+4. Select your `PresentMonTests.local.runsettings` file
+
+### Method 2: Command Line Parameter
+
+Run the test executable directly with the `--opttestdir` parameter:
+```
+PresentMonTests.exe --opttestdir="C:\path\to\your\tests"
+```
+
+### Method 3: Environment Variable
+
+Set the `PRESENTMON_ADDITIONAL_TEST_DIR` environment variable:
+```cmd
+set PRESENTMON_ADDITIONAL_TEST_DIR=C:\path\to\your\tests
+PresentMonTests.exe
+```
+
+### Test Directory Structure
+
+Your test directory should contain:
+- ETL files (e.g., `test_case.etl`)
+- Corresponding CSV files (e.g., `test_case.csv`, `test_case_v1.csv`, etc.)
+
+The test system will automatically discover and register tests for each ETL/CSV pair.
+
+### Notes
+
+- The `.local.runsettings` files are ignored by git, so your local paths won't be committed
+- Tests are dynamically registered at runtime based on the files found
+- Each CSV file creates a separate test case in Test Explorer