Add a system for testing correlation E2E

.github/actions/spelling/allow.txt

@@ -89,6 +89,7 @@ createtables
 cref
 csproj
 CStr
+csv
 CURSORPOSITON
 CUSTOMHEADER
 cwctype
@@ -188,7 +189,9 @@ hfile
 HGLOBAL
 HIDECANCEL
 hinternet
+HKCU
 HKEY
+HKLM
 hmac
 HMODULE
 Homepage
@@ -445,6 +448,7 @@ screenshots
 SCROLLER
 SCROLLVIEWER
 sdk
+sdks
 seekg
 seinfo
 selectany
@@ -538,6 +542,7 @@ TEXTFORMAT
 TEXTINCLUDE
 Threadpool
 Timeline
+tls
 todo
 tokenizer
 tolower

.github/actions/spelling/excludes.txt

@@ -37,4 +37,6 @@ ignore$
 ^src/JsonCppLib/
 ^src/Valijson/
 ^src/YamlCppLib/
+# Because it doesn't handle argument -Words well
+^tools/CorrelationTestbed/.*\.ps1$
 ^\.github/

.github/actions/spelling/expect.txt

@@ -407,6 +407,7 @@ vscode
 vstest
 vy
 wcslen
+WDAG
 webpages
 Webserver
 website
@@ -422,6 +423,7 @@ winreg
 withstarts
 wn
 Workflows
+wsb
 wsl
 wsv
 wto

src/AppInstallerCLIPackage/Package.appxmanifest

@@ -16,7 +16,6 @@
   <Dependencies>
     <!-- Minimum supported version is 1809 (October 2018 Update, aka RS5) -->
     <TargetDeviceFamily Name="Windows.Desktop" MinVersion="10.0.17763.0" MaxVersionTested="10.0.19033.0" />
-    <PackageDependency Name="Microsoft.VCLibs.140.00.UWPDesktop" MinVersion="14.0.25426.0" Publisher="CN=Microsoft Corporation, O=Microsoft Corporation, L=Redmond, S=Washington, C=US" />
   </Dependencies>
   <Resources>
     <Resource Language="x-generate" />

src/AppInstallerCLITests/TestSource.cpp

@@ -50,6 +50,8 @@ namespace TestCommon
             return LocIndString{ VersionManifest.Channel };
         case PackageVersionProperty::SourceIdentifier:
             return LocIndString{ Source.lock()->GetIdentifier() };
+        case PackageVersionProperty::Publisher:
+            return LocIndString{ VersionManifest.DefaultLocalization.Get<AppInstaller::Manifest::Localization::Publisher>() };
         default:
             return {};
         }

src/AppInstallerRepositoryCore/Microsoft/SQLiteIndexSource.cpp

@@ -48,7 +48,8 @@ namespace AppInstaller::Repository::Microsoft
                     return LocIndString{ GetReferenceSource()->GetDetails().Name };
                 default:
                     // Values coming from the index will always be localized/independent.
-                    return LocIndString{ GetReferenceSource()->GetIndex().GetPropertyByManifestId(m_manifestId, property).value() };
+                    std::optional<std::string> optValue = GetReferenceSource()->GetIndex().GetPropertyByManifestId(m_manifestId, property);
+                    return LocIndString{ optValue ? optValue.value() :std::string{} };
                 }
             }
 

src/AppInstallerRepositoryCore/Microsoft/Schema/1_1/Interface.h

@@ -30,5 +30,8 @@ namespace AppInstaller::Repository::Microsoft::Schema::V1_1
         void PerformQuerySearch(V1_0::SearchResultsTable& resultsTable, const RequestMatch& query) const override;
         virtual SearchResult SearchInternal(const SQLite::Connection& connection, SearchRequest& request) const;
         virtual void PrepareForPackaging(SQLite::Connection& connection, bool vacuum);
+
+        // Gets a property already knowing that the manifest id is valid.
+        virtual std::optional<std::string> GetPropertyByManifestIdInternal(const SQLite::Connection& connection, SQLite::rowid_t manifestId, PackageVersionProperty property) const;
     };
 }

src/AppInstallerRepositoryCore/Microsoft/Schema/1_1/Interface_1_1.cpp

@@ -292,4 +292,24 @@ namespace AppInstaller::Repository::Microsoft::Schema::V1_1
             builder.Execute(connection);
         }
     }
+
+    std::optional<std::string> Interface::GetPropertyByManifestIdInternal(const SQLite::Connection& connection, SQLite::rowid_t manifestId, PackageVersionProperty property) const
+    {
+        switch (property)
+        {
+        case AppInstaller::Repository::PackageVersionProperty::Publisher:
+        {
+            // Publisher is not a primary data member in this version, but it may be stored in the metadata
+            if (ManifestMetadataTable::Exists(connection))
+            {
+                return ManifestMetadataTable::GetMetadataByManifestIdAndMetadata(connection, manifestId, PackageVersionMetadata::Publisher);
+            }
+
+            // No metadata, so no publisher
+            return {};
+        }
+        default:
+            return V1_0::Interface::GetPropertyByManifestIdInternal(connection, manifestId, property);
+        }
+    }
 }

src/AppInstallerRepositoryCore/Microsoft/Schema/1_1/ManifestMetadataTable.cpp

@@ -68,6 +68,25 @@ namespace AppInstaller::Repository::Microsoft::Schema::V1_1
         return result;
     }
 
+    std::optional<std::string> ManifestMetadataTable::GetMetadataByManifestIdAndMetadata(const SQLite::Connection& connection, SQLite::rowid_t manifestId, PackageVersionMetadata metadata)
+    {
+        using namespace Builder;
+
+        StatementBuilder builder;
+        builder.Select(s_ManifestMetadataTable_Value_Column).From(s_ManifestMetadataTable_Table_Name).
+            Where(s_ManifestMetadataTable_Manifest_Column).Equals(manifestId).
+            And(s_ManifestMetadataTable_Metadata_Column).Equals(metadata);
+
+        Statement statement = builder.Prepare(connection);
+
+        if (statement.Step())
+        {
+            return statement.GetColumn<std::string>(0);
+        }
+
+        return {};
+    }
+
     void ManifestMetadataTable::SetMetadataByManifestId(SQLite::Connection& connection, SQLite::rowid_t manifestId, PackageVersionMetadata metadata, std::string_view value)
     {
         using namespace Builder;

src/AppInstallerRepositoryCore/Microsoft/Schema/1_1/ManifestMetadataTable.h

@@ -26,6 +26,10 @@ namespace AppInstaller::Repository::Microsoft::Schema::V1_1
         // The table must exist.
         static ISQLiteIndex::MetadataResult GetMetadataByManifestId(const SQLite::Connection& connection, SQLite::rowid_t manifestId);
 
+        // Gets the specific metadata value for the manifest, if it exists.
+        // The table must exist.
+        static std::optional<std::string> GetMetadataByManifestIdAndMetadata(const SQLite::Connection& connection, SQLite::rowid_t manifestId, PackageVersionMetadata metadata);
+
         // Sets the metadata value for the given manifest.
         // The table must exist.
         static void SetMetadataByManifestId(SQLite::Connection& connection, SQLite::rowid_t manifestId, PackageVersionMetadata metadata, std::string_view value);

src/AppInstallerRepositoryCore/Public/winget/RepositorySearch.h

@@ -134,6 +134,7 @@ namespace AppInstaller::Repository
         RelativePath,
         // Returned in hexadecimal format
         ManifestSHA256Hash,
+        Publisher,
     };
 
     // A property of a package version that can have multiple values.

src/AppInstallerRepositoryCore/Rest/RestSource.cpp

@@ -201,6 +201,8 @@ namespace AppInstaller::Repository::Rest
                     return Utility::LocIndString{ m_versionInfo.VersionAndChannel.GetVersion().ToString() };
                 case PackageVersionProperty::Channel:
                     return Utility::LocIndString{ m_versionInfo.VersionAndChannel.GetChannel().ToString() };
+                case PackageVersionProperty::Publisher:
+                    return Utility::LocIndString{ m_package->PackageInfo().Publisher };
                 default:
                     return Utility::LocIndString{};
                 }

src/Microsoft.Management.Deployment/PackageManager.idl

@@ -270,6 +270,9 @@ namespace Microsoft.Management.Deployment
         {
             /// Checks if this package version has at least one applicable installer.
             Boolean HasApplicableInstaller { get; };
+
+            /// Gets the publisher string for this package version, if one is available.
+            String Publisher { get; };
         }
 
         /// DESIGN NOTE:

src/Microsoft.Management.Deployment/PackageVersionInfo.cpp

@@ -43,6 +43,10 @@ namespace winrt::Microsoft::Management::Deployment::implementation
     {
         return winrt::to_hstring(m_packageVersion->GetProperty(::AppInstaller::Repository::PackageVersionProperty::Name).get());
     }
+    hstring PackageVersionInfo::Publisher()
+    {
+        return winrt::to_hstring(m_packageVersion->GetProperty(::AppInstaller::Repository::PackageVersionProperty::Publisher).get());
+    }
     hstring PackageVersionInfo::Version()
     {
         return winrt::to_hstring(m_packageVersion->GetProperty(::AppInstaller::Repository::PackageVersionProperty::Version).get());

src/Microsoft.Management.Deployment/PackageVersionInfo.h

@@ -17,6 +17,7 @@ namespace winrt::Microsoft::Management::Deployment::implementation
         hstring GetMetadata(winrt::Microsoft::Management::Deployment::PackageVersionMetadataField const& metadataField);
         hstring Id();
         hstring DisplayName();
+        hstring Publisher();
         hstring Version();
         hstring Channel();
         winrt::Windows::Foundation::Collections::IVectorView<hstring> PackageFamilyNames();

tools/CorrelationTestbed/InSandboxScript.ps1

@@ -0,0 +1,111 @@
+Param(
+  [String] $DesktopAppInstallerPath,
+  [String[]] $DesktopAppInstallerDependencyPath,
+  [String] $PackageIdentifier,
+  [String] $SourceName,
+  [String] $OutputPath,
+  [Switch] $UseDev
+)
+
+function Get-ARPTable {
+  $registry_paths = @('HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall\*','HKLM:\Software\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\*', 'HKCU:\Software\Microsoft\Windows\CurrentVersion\Uninstall\*', 'HKCU:\Software\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\*')
+  return Get-ItemProperty $registry_paths -ErrorAction SilentlyContinue | 
+       Select-Object DisplayName, DisplayVersion, Publisher, @{N='ProductCode'; E={$_.PSChildName}} |
+       Where-Object {$null -ne $_.DisplayName }
+}
+
+$ProgressPreference = 'SilentlyContinue'
+
+$desktopPath = "C:\Users\WDAGUtilityAccount\Desktop"
+
+$regFilesDirPath = Join-Path $desktopPath "RegFiles"
+
+if (Test-Path $regFilesDirPath)
+{
+  foreach ($regFile in (Get-ChildItem $regFilesDirPath))
+  {
+
+    Write-Host @"
+--> Importing reg file $($regFile.FullName)
+"@
+    reg import $($regFile.FullName)
+  }
+}
+
+Write-Host @"
+--> Installing WinGet
+
+"@
+
+if ($UseDev)
+{
+  foreach($dependency in $DesktopAppInstallerDependencyPath)
+  {
+    Write-Host @"
+  ----> Installing $dependency
+"@
+    Add-AppxPackage -Path $dependency
+  }
+
+  Write-Host @"
+  ----> Enabling dev mode
+"@
+  reg add "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\AppModelUnlock" /t REG_DWORD /f /v "AllowDevelopmentWithoutDevLicense" /d "1"
+
+  $devPackageManifestPath = Join-Path $desktopPath "DevPackage\AppxManifest.xml"
+  Write-Host @"
+  ----> Installing $devPackageManifestPath
+"@
+  Add-AppxPackage -Path $devPackageManifestPath -Register
+}
+else
+{
+  Add-AppxPackage -Path $DesktopAppInstallerPath -DependencyPath $DesktopAppInstallerDependencyPath
+}
+
+$originalARP = Get-ARPTable
+
+Write-Host @"
+
+--> Installing $PackageIdentifier
+
+"@
+
+$installAndCorrelateOutPath = Join-Path $OutputPath "install_and_correlate.json"
+
+$installAndCorrelationExpression = Join-Path $desktopPath "InstallAndCheckCorrelation\InstallAndCheckCorrelation.exe"
+$installAndCorrelationExpression = -join($installAndCorrelationExpression, ' -id "', $PackageIdentifier, '" -src "', $SourceName, '" -out "', $installAndCorrelateOutPath, '"')
+
+if ($UseDev)
+{
+  $installAndCorrelationExpression = -join($installAndCorrelationExpression, ' -dev')
+}
+
+Invoke-Expression $installAndCorrelationExpression
+
+Write-Host @"
+
+--> Copying logs
+"@
+
+if ($UseDev)
+{
+  Copy-Item -Recurse (Join-Path $env:LOCALAPPDATA "Packages\WinGetDevCLI_8wekyb3d8bbwe\LocalState\DiagOutputDir") $OutputPath
+}
+else
+{
+  Copy-Item -Recurse (Join-Path $env:LOCALAPPDATA "Packages\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\LocalState\DiagOutputDir") $OutputPath
+}
+
+
+Write-Host @"
+
+--> Comparing ARP Entries
+"@
+
+$arpCompared = (Compare-Object (Get-ARPTable) $originalARP -Property DisplayName,DisplayVersion,Publisher,ProductCode)
+$arpCompared | Select-Object -Property * -ExcludeProperty SideIndicator | Format-Table
+
+$arpCompared | Select-Object -Property * -ExcludeProperty SideIndicator | Format-Table | Out-File (Join-Path $OutputPath "ARPCompare.txt")
+
+"Done" | Out-File (Join-Path $OutputPath "done.txt")

tools/CorrelationTestbed/InstallAndCheckCorrelation/InstallAndCheckCorrelation.sln

@@ -0,0 +1,31 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.31911.196
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "InstallAndCheckCorrelation", "InstallAndCheckCorrelation\InstallAndCheckCorrelation.vcxproj", "{204CD25F-AAEA-4CA1-AB9F-A26747976932}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|x64 = Debug|x64
+		Debug|x86 = Debug|x86
+		Release|x64 = Release|x64
+		Release|x86 = Release|x86
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{204CD25F-AAEA-4CA1-AB9F-A26747976932}.Debug|x64.ActiveCfg = Debug|x64
+		{204CD25F-AAEA-4CA1-AB9F-A26747976932}.Debug|x64.Build.0 = Debug|x64
+		{204CD25F-AAEA-4CA1-AB9F-A26747976932}.Debug|x86.ActiveCfg = Debug|Win32
+		{204CD25F-AAEA-4CA1-AB9F-A26747976932}.Debug|x86.Build.0 = Debug|Win32
+		{204CD25F-AAEA-4CA1-AB9F-A26747976932}.Release|x64.ActiveCfg = Release|x64
+		{204CD25F-AAEA-4CA1-AB9F-A26747976932}.Release|x64.Build.0 = Release|x64
+		{204CD25F-AAEA-4CA1-AB9F-A26747976932}.Release|x86.ActiveCfg = Release|Win32
+		{204CD25F-AAEA-4CA1-AB9F-A26747976932}.Release|x86.Build.0 = Release|Win32
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {77ED5C57-8A8C-4D87-9818-ABFB99B8E9D2}
+	EndGlobalSection
+EndGlobal