commit e8e5f502d6eaa5c4771d0f0f374632fd679decba parent 7610bf162263026c737b6d9578e4bcb8acd42c27 Author: JohnMcPMS <johnmcp@microsoft.com> Date: Tue, 30 Jul 2024 11:20:10 -0700 Update metadata collection tooling (#4688) ## Change - Fix comment in script about release build requirement - Add metadata parameters to README - Update metadata output version to latest value Diffstat:
3 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/tools/CorrelationTestbed/InstallAndCheckCorrelation/InstallAndCheckCorrelation/InstallAndCheckCorrelation.cpp b/tools/CorrelationTestbed/InstallAndCheckCorrelation/InstallAndCheckCorrelation/InstallAndCheckCorrelation.cpp @@ -350,7 +350,7 @@ struct Main std::ofstream stream{ metadataInputPath }; stream << "{" << std::endl; - stream << JSONPair{ "supportedMetadataVersion", "1.1"}; + stream << JSONPair{ "supportedMetadataVersion", "1.2"}; // TODO: Could theoretically produce this if we could enumerate the data via COM // stream << JSONPair{ "currentMetadata", "" }; stream << JSONPair{ "submissionData", nullptr, false } << "\n{\n"; diff --git a/tools/CorrelationTestbed/Readme.md b/tools/CorrelationTestbed/Readme.md @@ -19,6 +19,8 @@ Test-CorrelationInSandbox.ps1 [-DevPackagePath <string>] :: Path to the local dev *Release* winget build; defaults to the normal location [-ResultsPath <string>] :: Path to output the results to; defaults to a temp directory [-RegFileDirectory <string>] :: Path to a directory containing .reg files to insert before the test, creating noise for correlation +[-MetadataCollection] :: Switch to enable collection of metadata +[-WingetUtilPath <string>] :: Path to the WinGetUtil.dll to use; defaults to Debug build location ``` Once testing is done, `Process-CorrelationResults.ps1` will take all of the results JSON files and put them into `results.csv` in the directory. If any tests failed to run, they will be in `failed.csv`. There are correlation columns in the CSV that can be averaged in Excel to get the correlation percentage. diff --git a/tools/CorrelationTestbed/Test-CorrelationInSandbox.ps1 b/tools/CorrelationTestbed/Test-CorrelationInSandbox.ps1 @@ -18,7 +18,7 @@ Param( [String] $RegFileDirectory, [Parameter(HelpMessage = "Indicates that the metadata collection process should be run.")] [Switch] $MetadataCollection, - [Parameter(HelpMessage = "The path to WinGetUtil.dll; only the release build works.")] + [Parameter(HelpMessage = "The path to WinGetUtil.dll.")] [String] $WingetUtilPath, [Parameter(HelpMessage = "Wait for user input before tearing down each sandbox.")] [Switch] $Wait