Validate manifest installers (MSIX)

src/AppInstallerCLITests/AppInstallerCLITests.vcxproj

@@ -200,6 +200,7 @@
     <ClCompile Include="JsonHelper.cpp" />
     <ClCompile Include="MsiExecArguments.cpp" />
     <ClCompile Include="MsixInfo.cpp" />
+    <ClCompile Include="MsixManifest.cpp" />
     <ClCompile Include="NameNormalization.cpp" />
     <ClCompile Include="PackageCollection.cpp" />
     <ClCompile Include="PackageTrackingCatalog.cpp" />
@@ -560,7 +561,7 @@
     </CopyFileToFolders>
     <CopyFileToFolders Include="TestData\UpdateFlowTest_Portable.yaml">
       <DeploymentContent>true</DeploymentContent>
-    </CopyFileToFolders> 
+    </CopyFileToFolders>
     <CopyFileToFolders Include="TestData\InputNames.txt">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>
@@ -630,6 +631,21 @@
     <CopyFileToFolders Include="TestData\Installer_Exe_DependenciesMultideclaration.yaml">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\InstallerManifestValidation.msix">
+      <DeploymentContent>true</DeploymentContent>
+    </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\InstallerManifestValidation.msixbundle">
+      <DeploymentContent>true</DeploymentContent>
+    </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Manifest-Good-MsixInstaller.yaml">
+      <DeploymentContent>true</DeploymentContent>
+    </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Manifest-Bad-MsixInstaller.yaml">
+      <DeploymentContent>true</DeploymentContent>
+    </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Manifest-Missing-MsixInstallerFields.yaml">
+      <DeploymentContent>true</DeploymentContent>
+    </CopyFileToFolders>
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\AppInstallerCLICore\AppInstallerCLICore.vcxproj">

src/AppInstallerCLITests/AppInstallerCLITests.vcxproj.filters

@@ -191,6 +191,9 @@
     <ClCompile Include="Correlation.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="MsixManifest.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="PropertySheet.props" />
@@ -585,5 +588,20 @@
     <CopyFileToFolders Include="TestData\InputARPData.txt">
       <Filter>TestData</Filter>
     </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\InstallerManifestValidation.msix">
+      <Filter>TestData</Filter>
+    </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\InstallerManifestValidation.msixbundle">
+      <Filter>TestData</Filter>
+    </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Manifest-Good-MsixInstaller.yaml">
+      <Filter>TestData</Filter>
+    </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Manifest-Bad-MsixInstaller.yaml">
+      <Filter>TestData</Filter>
+    </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Manifest-Missing-MsixInstallerFields.yaml">
+      <Filter>TestData</Filter>
+    </CopyFileToFolders>
   </ItemGroup>
 </Project>

src/AppInstallerCLITests/MsixInfo.cpp

@@ -15,7 +15,7 @@ constexpr std::string_view s_MsixFile_1 = "index.1.0.0.0.msix";
 constexpr std::string_view s_MsixFile_2 = "index.2.0.0.0.msix";
 constexpr std::string_view s_MsixFileSigned_1 = "index.1.0.0.0.signed.msix";
 
-TEST_CASE("MsixInfo_GetPackageFamilyName", "[msixinfo]")
+TEST_CASE("MsixInfo_GetPackageFullName", "[msixinfo]")
 {
     TestDataFile index(s_MsixFile_1);
     Msix::MsixInfo msix(index.GetPath());

src/AppInstallerCLITests/MsixManifest.cpp

@@ -0,0 +1,88 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+#include "pch.h"
+#include "TestCommon.h"
+#include <AppInstallerMsixInfo.h>
+#include <AppInstallerDownloader.h>
+#include <AppInstallerRuntime.h>
+#include <winget/MsixManifest.h>
+
+using namespace std;
+using namespace TestCommon;
+using namespace AppInstaller;
+using namespace AppInstaller::Msix;
+using namespace Microsoft::WRL;
+
+// Input values
+constexpr std::string_view installerManifestValidationMsix = "InstallerManifestValidation.msix";
+constexpr std::string_view installerManifestValidationMsixBundle = "InstallerManifestValidation.msixbundle";
+
+// Expected 
+constexpr std::string_view expectedFamilyName = "FakeInstallerForTesting_125rzkzqaqjwj";
+PackageVersion expectedPackageVersion = { 0xAAAABBBBCCCCDDDD };
+constexpr std::string_view expectedWindowsDesktopName = "Windows.Desktop";
+OSVersion expectedWindowsDesktopMinVersion = { 0x000a00003FAB0000 }; // 10.0.16299.0
+OSVersion expectedWindowsUniversalMinVersion = { 0x000a000000000000 }; // 10.0.0.0
+
+TEST_CASE("MsixManifest_ValidateFieldsParsedFromManifestReader", "[MsixManifest]")
+{
+    ComPtr<IAppxManifestReader> manifestReader;
+    if (!GetMsixPackageManifestReader(installerManifestValidationMsix, &manifestReader))
+    {
+        FAIL();
+    }
+
+    Msix::MsixPackageManifest msixManifest(manifestReader);
+    REQUIRE(expectedFamilyName == msixManifest.GetIdentity().GetPackageFamilyName());
+    REQUIRE(expectedPackageVersion == msixManifest.GetIdentity().GetVersion());
+    REQUIRE(2 == msixManifest.GetTargetDeviceFamilies().size());
+    REQUIRE(expectedWindowsUniversalMinVersion == msixManifest.GetMinimumOSVersion().value());
+
+    auto targets = msixManifest.GetTargetDeviceFamilies();
+    auto windowsDesktop = std::find_if(targets.begin(), targets.end(), [](auto& t) { return t.GetMinVersion() == expectedWindowsDesktopMinVersion; });
+    REQUIRE(windowsDesktop != targets.end());
+
+    auto windowsUniversal = std::find_if(targets.begin(), targets.end(), [](auto& t) { return t.GetMinVersion() == expectedWindowsUniversalMinVersion; });
+    REQUIRE(windowsUniversal != targets.end());
+}
+
+TEST_CASE("MsixManifest_ValidateFieldsParsedFromMsix", "[MsixManifest]")
+{
+    TestDataFile testFile(installerManifestValidationMsix);
+    MsixInfo msixInfo(testFile.GetPath());
+
+    auto appPackageManifests = msixInfo.GetAppPackageManifests();
+    REQUIRE(1 == appPackageManifests.size());
+
+    auto &appPackageManifest = appPackageManifests[0];
+    REQUIRE(expectedFamilyName == appPackageManifest.GetIdentity().GetPackageFamilyName());
+    REQUIRE(expectedPackageVersion == appPackageManifest.GetIdentity().GetVersion());
+    REQUIRE(2 == appPackageManifest.GetTargetDeviceFamilies().size());
+    REQUIRE(expectedWindowsUniversalMinVersion == appPackageManifest.GetMinimumOSVersion().value());
+
+    auto targets = appPackageManifest.GetTargetDeviceFamilies();
+    auto windowsDesktop = std::find_if(targets.begin(), targets.end(), [](auto& t) { return t.GetMinVersion() == expectedWindowsDesktopMinVersion; });
+    REQUIRE(windowsDesktop != targets.end());
+
+    auto windowsUniversal = std::find_if(targets.begin(), targets.end(), [](auto& t) { return t.GetMinVersion() == expectedWindowsUniversalMinVersion; });
+    REQUIRE(windowsUniversal != targets.end());
+}
+
+TEST_CASE("MsixManifest_ValidateFieldsParsedFromMsixBundle", "[MsixManifest]")
+{
+    TestDataFile testFile(installerManifestValidationMsixBundle);
+    MsixInfo msixInfo(testFile.GetPath());
+
+    auto appPackageManifests = msixInfo.GetAppPackageManifests();
+    REQUIRE(2 == appPackageManifests.size());
+
+    for (auto& appPackageManifest : appPackageManifests)
+    {
+        REQUIRE(expectedFamilyName == appPackageManifest.GetIdentity().GetPackageFamilyName());
+        REQUIRE(expectedPackageVersion == appPackageManifest.GetIdentity().GetVersion());
+        REQUIRE(1 == appPackageManifest.GetTargetDeviceFamilies().size());
+        REQUIRE(expectedWindowsDesktopName == appPackageManifest.GetTargetDeviceFamilies().front().GetName());
+        REQUIRE(expectedWindowsDesktopMinVersion == appPackageManifest.GetTargetDeviceFamilies().front().GetMinVersion());
+        REQUIRE(expectedWindowsDesktopMinVersion == appPackageManifest.GetMinimumOSVersion().value());
+    }
+}

src/AppInstallerCLITests/TestCommon.cpp

@@ -6,6 +6,7 @@
 #include <winget/GroupPolicy.h>
 #include <winget/UserSettings.h>
 #include <AppInstallerMsixInfo.h>
+#include <AppInstallerDownloader.h>
 
 namespace TestCommon
 {
@@ -285,4 +286,19 @@ namespace TestCommon
 
         return false;
     }
+
+    bool GetMsixPackageManifestReader(const std::string_view testFileName, IAppxManifestReader** manifestReader)
+    {
+        // Locate test file
+        TestDataFile testFile(testFileName);
+        auto path = testFile.GetPath().u8string();
+
+        // Get the stream for the test file
+        auto stream = AppInstaller::Utility::GetStreamFromURI(path);
+
+        // Get manifest from package reader
+        Microsoft::WRL::ComPtr<IAppxPackageReader> packageReader;
+        return  AppInstaller::Msix::GetPackageReader(stream.Get(), &packageReader)
+            && SUCCEEDED(packageReader->GetManifest(manifestReader));
+    }
 }

src/AppInstallerCLITests/TestCommon.h

@@ -3,6 +3,7 @@
 #pragma once
 #include <AppInstallerLogging.h>
 #include <AppInstallerProgress.h>
+#include <AppxPackaging.h>
 #include <winget/UserSettings.h>
 #include <wil/result.h>
 
@@ -135,4 +136,7 @@ namespace TestCommon
     // tests calling these functions should skip when not running with admin.
     bool InstallCertFromSignedPackage(const std::filesystem::path& package);
     bool UninstallCertFromSignedPackage(const std::filesystem::path& package);
+
+    // Get manifest reader from a msix file path
+    bool GetMsixPackageManifestReader(const std::string_view testFileName, IAppxManifestReader** manifestReader);
 }

src/AppInstallerCLITests/TestData/Manifest-Bad-MsixInstaller.yaml

@@ -0,0 +1,13 @@
+PackageIdentifier: AppInstallerCliTest.BadMsixInstaller
+PackageVersion: 1.2.3.4                           # Mismatching value with msix installer
+PackageLocale: es-MX
+PackageName: es-MX package name
+Publisher: es-MX publisher
+PackageFamilyName: FakeInstallerForTesting_Bad    # Mismatching value with msix installer
+MinimumOSVersion: 5.6.7.8                         # Mismatching value with msix installer
+InstallerType: msix
+Installers: 
+    - Architecture: x64
+      InstallerUrl: InstallerManifestValidation.msix
+ManifestType: merged
+ManifestVersion: 1.0.0

src/AppInstallerCLITests/TestData/Manifest-Good-MsixInstaller.yaml

@@ -0,0 +1,13 @@
+PackageIdentifier: AppInstallerCliTest.GoodMsixInstaller
+PackageVersion: 43690.48059.52428.56797
+PackageLocale: es-MX
+PackageName: es-MX package name
+Publisher: es-MX publisher
+PackageFamilyName: FakeInstallerForTesting_125rzkzqaqjwj
+MinimumOSVersion: 10.0.0.0
+InstallerType: msix
+Installers: 
+    - Architecture: x64
+      InstallerUrl: InstallerManifestValidation.msix
+ManifestType: merged
+ManifestVersion: 1.0.0

src/AppInstallerCLITests/TestData/Manifest-Missing-MsixInstallerFields.yaml

@@ -0,0 +1,13 @@
+PackageIdentifier: AppInstallerCliTest.GoodMsixInstaller
+PackageVersion: 43690.48059.52428.56797
+PackageLocale: es-MX
+PackageName: es-MX package name
+Publisher: es-MX publisher
+# PackageFamilyName: FakeInstallerForTesting_125rzkzqaqjwj    # Missing field
+# MinimumOSVersion: 10.0.16299.0                              # Missing field
+InstallerType: msix
+Installers: 
+    - Architecture: x64
+      InstallerUrl: InstallerManifestValidation.msix
+ManifestType: merged
+ManifestVersion: 1.0.0

src/AppInstallerCLITests/Versions.cpp

@@ -191,3 +191,40 @@ TEST_CASE("VersionUnknownLessThanLatest", "[versions]")
 {
     REQUIRE(Version::CreateUnknown() < Version::CreateLatest());
 }
+
+TEST_CASE("FourPartsVersionNumber_Success_FourParts", "[versions]")
+{
+    Version expectedVersion("1.2.3.4");
+    FourPartsVersionNumber versionNumberFromNumber(0x0001000200030004);
+    FourPartsVersionNumber versionNumberFromString("1.2.3.4");
+    REQUIRE(expectedVersion == versionNumberFromNumber);
+    REQUIRE(expectedVersion == versionNumberFromString);
+    REQUIRE(expectedVersion.ToString() == versionNumberFromNumber.ToString());
+    REQUIRE(expectedVersion.ToString() == versionNumberFromString.ToString());
+}
+
+TEST_CASE("FourPartsVersionNumber_Success_LessThanFourParts", "[versions]")
+{
+    FourPartsVersionNumber versionNumberFromNumber(0x0001000200030000);
+    FourPartsVersionNumber versionNumberFromString("1.2.3");
+    REQUIRE(versionNumberFromNumber == versionNumberFromString);
+}
+
+TEST_CASE("FourPartsVersionNumber_Fail_OverflowComparison", "[versions]")
+{
+    FourPartsVersionNumber versionNumberFromString("1.0.0.65536"); // 65536 => 0x10000
+    FourPartsVersionNumber versionNumberFromNumber(0x0001000000000000); // 1.0.0.0
+    REQUIRE(versionNumberFromString != versionNumberFromNumber);
+    REQUIRE("1.0.0.65536" == versionNumberFromString.ToString());
+    REQUIRE("1.0.0.0" == versionNumberFromNumber.ToString());
+}
+
+TEST_CASE("FourPartsVersionNumber_Fail_MoreThanFourParts", "[versions]")
+{
+    REQUIRE_THROWS(FourPartsVersionNumber("1.0.0.0.1"));
+}
+
+TEST_CASE("FourPartsVersionNumber_Fail_NonNumeric", "[versions]")
+{
+    REQUIRE_THROWS(FourPartsVersionNumber("1.0.0.a"));
+}

src/AppInstallerCLITests/YamlManifest.cpp

@@ -836,4 +836,80 @@ TEST_CASE("ManifestLocalizationValidation", "[ManifestValidation]")
     errors = ValidateManifest(manifest, false);
     REQUIRE(errors.size() == 1);
     REQUIRE(errors.at(0).ErrorLevel == ValidationError::Level::Warning);
-}
+}
+
+TEST_CASE("ReadManifestAndValidateMsixInstallers_Success", "[ManifestValidation]")
+{
+    auto testFile = TestDataFile("Manifest-Good-MsixInstaller.yaml");
+    Manifest manifest = YamlParser::CreateFromPath(testFile);
+
+    // Update the installer path for testing
+    REQUIRE(1 == manifest.Installers.size());
+    auto msixFile = TestDataFile(manifest.Installers[0].Url.c_str());
+    manifest.Installers[0].Url = msixFile.GetPath().u8string();
+
+    auto errors = ValidateManifestInstallers(manifest);
+    REQUIRE(0 == errors.size());
+}
+
+TEST_CASE("ReadManifestAndValidateMsixInstallers_Bad", "[ManifestValidation]")
+{
+    auto testFile = TestDataFile("Manifest-Bad-MsixInstaller.yaml");
+    Manifest manifest = YamlParser::CreateFromPath(testFile);
+
+    // Update the installer path for testing
+    REQUIRE(1 == manifest.Installers.size());
+    auto msixFile = TestDataFile(manifest.Installers[0].Url.c_str());
+    manifest.Installers[0].Url = msixFile.GetPath().u8string();
+
+    auto errors = ValidateManifestInstallers(manifest);
+    REQUIRE(3 == errors.size());
+
+    // Package family name
+    REQUIRE(ValidationError::Level::Error == errors[0].ErrorLevel);
+    REQUIRE(ManifestError::InstallerMsixInconsistencies == errors[0].Message);
+    REQUIRE("PackageFamilyName" == errors[0].Field);
+    REQUIRE("FakeInstallerForTesting_125rzkzqaqjwj" == errors[0].Value);
+
+    // Package version
+    REQUIRE(ValidationError::Level::Error == errors[1].ErrorLevel);
+    REQUIRE(ManifestError::InstallerMsixInconsistencies == errors[1].Message);
+    REQUIRE("PackageVersion" == errors[1].Field);
+    REQUIRE("43690.48059.52428.56797" == errors[1].Value);
+
+    // Min OS version
+    REQUIRE(ValidationError::Level::Error == errors[2].ErrorLevel);
+    REQUIRE(ManifestError::InstallerMsixInconsistencies == errors[2].Message);
+    REQUIRE("MinimumOSVersion" == errors[2].Field);
+    REQUIRE("10.0.0.0" == errors[2].Value);
+}
+
+TEST_CASE("ReadManifestAndValidateMsixInstallers_MissingFields", "[ManifestValidation]")
+{
+    auto testFile = TestDataFile("Manifest-Missing-MsixInstallerFields.yaml");
+    Manifest manifest = YamlParser::CreateFromPath(testFile);
+
+    // Update the installer path for testing
+    REQUIRE(1 == manifest.Installers.size());
+    auto msixFile = TestDataFile(manifest.Installers[0].Url.c_str());
+    manifest.Installers[0].Url = msixFile.GetPath().u8string();
+
+    for (bool treatErrorAsWarning : { false, true })
+    {
+        auto errors = ValidateManifestInstallers(manifest, treatErrorAsWarning);
+        auto expectedLevel = treatErrorAsWarning ? ValidationError::Level::Warning : ValidationError::Level::Error;
+        REQUIRE(2 == errors.size());
+
+        // Package family name
+        REQUIRE(expectedLevel == errors[0].ErrorLevel);
+        REQUIRE(ManifestError::OptionalFieldMissing == errors[0].Message);
+        REQUIRE("PackageFamilyName" == errors[0].Field);
+        REQUIRE("FakeInstallerForTesting_125rzkzqaqjwj" == errors[0].Value);
+
+        // Min OS version
+        REQUIRE(expectedLevel == errors[1].ErrorLevel);
+        REQUIRE(ManifestError::OptionalFieldMissing == errors[1].Message);
+        REQUIRE("MinimumOSVersion" == errors[1].Field);
+        REQUIRE("10.0.0.0" == errors[1].Value);
+    }
+}

src/AppInstallerCommonCore/AppInstallerCommonCore.vcxproj

@@ -278,6 +278,7 @@
   </ItemDefinitionGroup>
   <ItemGroup>
     <ClInclude Include="DODownloader.h" />
+    <ClInclude Include="Public\winget\MsixManifest.h" />
     <ClInclude Include="Public\winget\AdminSettings.h" />
     <ClInclude Include="Public\winget\Debugging.h" />
     <ClInclude Include="Public\winget\DependenciesGraph.h" />
@@ -379,6 +380,7 @@
     <ClCompile Include="MsixInfo.cpp">
       <ExcludedFromBuild Condition="'$(Configuration)'=='Fuzzing'">true</ExcludedFromBuild>
     </ClCompile>
+    <ClCompile Include="MsixManifest.cpp" />
     <ClCompile Include="NameNormalization.cpp" />
     <ClCompile Include="Regex.cpp" />
     <ClCompile Include="Registry.cpp" />