Validate manifest installers (MSIX)

src/AppInstallerCLITests/AppInstallerCLITests.vcxproj

@@ -270,7 +270,7 @@
     </CopyFileToFolders>
     <CopyFileToFolders Include="TestData\InstallFlowTest_InstallationNotes.yaml">
       <DeploymentContent>true</DeploymentContent>
-    </CopyFileToFolders>    
+    </CopyFileToFolders>
     <CopyFileToFolders Include="TestData\InstallFlowTest_Portable.yaml">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>
@@ -649,19 +649,25 @@
     <CopyFileToFolders Include="TestData\Installer_Exe_DependenciesMultideclaration.yaml">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>
-    <CopyFileToFolders Include="TestData\InstallerManifestValidation.msix">
+    <CopyFileToFolders Include="TestData\Manifest-Good-MsixInstaller.yaml">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>
-    <CopyFileToFolders Include="TestData\InstallerManifestValidation.msixbundle">
+    <CopyFileToFolders Include="TestData\Manifest-Bad-InconsistentMsixInstallerFields.yaml">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>
-    <CopyFileToFolders Include="TestData\Manifest-Good-MsixInstaller.yaml">
+    <CopyFileToFolders Include="TestData\Manifest-Bad-MissingMsixInstallerFields.yaml">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>
-    <CopyFileToFolders Include="TestData\Manifest-Bad-InconsistentMsixInstallerFields.yaml">
+    <CopyFileToFolders Include="TestData\Manifest-Bad-NoSupportedPlatforms.yaml">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>
-    <CopyFileToFolders Include="TestData\Manifest-Bad-MissingMsixInstallerFields.yaml">
+    <CopyFileToFolders Include="TestData\Installer-Bad-NoSupportedPlatforms.msix">
+      <DeploymentContent>true</DeploymentContent>
+    </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Installer-Good.msix">
+      <DeploymentContent>true</DeploymentContent>
+    </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Installer-Good.msixbundle">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>
   </ItemGroup>

src/AppInstallerCLITests/AppInstallerCLITests.vcxproj.filters

@@ -464,7 +464,7 @@
     </CopyFileToFolders>
     <CopyFileToFolders Include="TestData\InstallFlowTest_InstallationNotes.yaml">
       <Filter>TestData</Filter>
-    </CopyFileToFolders>    
+    </CopyFileToFolders>
     <CopyFileToFolders Include="TestData\InstallFlowTest_Portable.yaml">
       <Filter>TestData</Filter>
     </CopyFileToFolders>
@@ -606,12 +606,6 @@
     <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>
@@ -621,5 +615,15 @@
     <CopyFileToFolders Include="TestData\Manifest-Bad-MissingMsixInstallerFields.yaml">
       <Filter>TestData</Filter>
     </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Manifest-Bad-NoSupportedPlatforms.yaml">
+      <DeploymentContent>true</DeploymentContent>
+    </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Installer-Good.msix">
+      <DeploymentContent>true</DeploymentContent>
+    </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Installer-Good.msixbundle">
+      <DeploymentContent>true</DeploymentContent>
+    </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Installer-Bad-NoSupportedPlatforms.msix" />
   </ItemGroup>
 </Project>

src/AppInstallerCLITests/MsixManifest.cpp

@@ -12,13 +12,11 @@ using namespace AppInstaller;
 using namespace AppInstaller::Msix;
 using namespace Microsoft::WRL;
 
-constexpr std::string_view Remove = "InstallerManifestValidation.msix";
-
 namespace
 {
     // Input values
-    constexpr std::string_view installerManifestValidationMsix = "InstallerManifestValidation.msix";
-    constexpr std::string_view installerManifestValidationMsixBundle = "InstallerManifestValidation.msixbundle";
+    constexpr std::string_view installerGoodMsix = "Installer-Good.msix";
+    constexpr std::string_view installerGoodMsixBundle = "Installer-Good.msixbundle";
 
     // Expected
     constexpr std::string_view expectedFamilyName = "FakeInstallerForTesting_125rzkzqaqjwj";
@@ -31,13 +29,13 @@ namespace
 TEST_CASE("MsixManifest_ValidateFieldsParsedFromManifestReader", "[MsixManifest]")
 {
     ComPtr<IAppxManifestReader> manifestReader;
-    REQUIRE(GetMsixPackageManifestReader(installerManifestValidationMsix, &manifestReader));
+    REQUIRE(GetMsixPackageManifestReader(installerGoodMsix, &manifestReader));
 
     Msix::MsixPackageManifest msixManifest(manifestReader);
     REQUIRE(expectedFamilyName == msixManifest.GetIdentity().GetPackageFamilyName());
     REQUIRE(expectedPackageVersion == msixManifest.GetIdentity().GetVersion());
     REQUIRE(2 == msixManifest.GetTargetDeviceFamilies().size());
-    REQUIRE(expectedWindowsDesktopMinVersion == msixManifest.GetMinimumOSVersion());
+    REQUIRE(expectedWindowsDesktopMinVersion == msixManifest.GetMinimumOSVersionForSupportedPlatforms().value());
 
     auto targets = msixManifest.GetTargetDeviceFamilies();
     auto windowsDesktop = std::find_if(targets.begin(), targets.end(), [](auto& t) { return t.GetMinVersion() == expectedWindowsDesktopMinVersion; });
@@ -49,7 +47,7 @@ TEST_CASE("MsixManifest_ValidateFieldsParsedFromManifestReader", "[MsixManifest]
 
 TEST_CASE("MsixManifest_ValidateFieldsParsedFromMsix", "[MsixManifest]")
 {
-    TestDataFile testFile(installerManifestValidationMsix);
+    TestDataFile testFile(installerGoodMsix);
     MsixInfo msixInfo(testFile.GetPath());
 
     auto appPackageManifests = msixInfo.GetAppPackageManifests();
@@ -59,7 +57,7 @@ TEST_CASE("MsixManifest_ValidateFieldsParsedFromMsix", "[MsixManifest]")
     REQUIRE(expectedFamilyName == appPackageManifest.GetIdentity().GetPackageFamilyName());
     REQUIRE(expectedPackageVersion == appPackageManifest.GetIdentity().GetVersion());
     REQUIRE(2 == appPackageManifest.GetTargetDeviceFamilies().size());
-    REQUIRE(expectedWindowsDesktopMinVersion == appPackageManifest.GetMinimumOSVersion());
+    REQUIRE(expectedWindowsDesktopMinVersion == appPackageManifest.GetMinimumOSVersionForSupportedPlatforms().value());
 
     auto targets = appPackageManifest.GetTargetDeviceFamilies();
     auto windowsDesktop = std::find_if(targets.begin(), targets.end(), [](auto& t) { return t.GetMinVersion() == expectedWindowsDesktopMinVersion; });
@@ -71,7 +69,7 @@ TEST_CASE("MsixManifest_ValidateFieldsParsedFromMsix", "[MsixManifest]")
 
 TEST_CASE("MsixManifest_ValidateFieldsParsedFromMsixBundle", "[MsixManifest]")
 {
-    TestDataFile testFile(installerManifestValidationMsixBundle);
+    TestDataFile testFile(installerGoodMsixBundle);
     MsixInfo msixInfo(testFile.GetPath());
 
     auto appPackageManifests = msixInfo.GetAppPackageManifests();
@@ -84,6 +82,6 @@ TEST_CASE("MsixManifest_ValidateFieldsParsedFromMsixBundle", "[MsixManifest]")
         REQUIRE(1 == appPackageManifest.GetTargetDeviceFamilies().size());
         REQUIRE(expectedWindowsDesktopName == appPackageManifest.GetTargetDeviceFamilies().front().GetName());
         REQUIRE(expectedWindowsDesktopMinVersion == appPackageManifest.GetTargetDeviceFamilies().front().GetMinVersion());
-        REQUIRE(expectedWindowsDesktopMinVersion == appPackageManifest.GetMinimumOSVersion());
+        REQUIRE(expectedWindowsDesktopMinVersion == appPackageManifest.GetMinimumOSVersionForSupportedPlatforms().value());
     }
 }

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

@@ -8,6 +8,6 @@ MinimumOSVersion: 5.6.7.8                         # Mismatching value with msix
 InstallerType: msix
 Installers: 
     - Architecture: x64
-      InstallerUrl: InstallerManifestValidation.msix
+      InstallerUrl: Installer-Good.msix
 ManifestType: merged
 ManifestVersion: 1.0.0

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

@@ -8,6 +8,6 @@ Publisher: es-MX publisher
 InstallerType: msix
 Installers: 
     - Architecture: x64
-      InstallerUrl: InstallerManifestValidation.msix
+      InstallerUrl: Installer-Good.msix
 ManifestType: merged
 ManifestVersion: 1.0.0

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

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

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

@@ -8,6 +8,6 @@ MinimumOSVersion: 10.0.16299.0
 InstallerType: msix
 Installers: 
     - Architecture: x64
-      InstallerUrl: InstallerManifestValidation.msix
+      InstallerUrl: Installer-Good.msix
 ManifestType: merged
 ManifestVersion: 1.0.0

src/AppInstallerCLITests/YamlManifest.cpp

@@ -886,6 +886,26 @@ TEST_CASE("ReadManifestAndValidateMsixInstallers_InconsistentFields", "[Manifest
     REQUIRE("10.0.16299.0" == errors[2].Value);
 }
 
+TEST_CASE("ReadManifestAndValidateMsixInstallers_NoSupportedPlatforms", "[ManifestValidation]")
+{
+    auto testFileName = "Manifest-Bad-NoSupportedPlatforms.yaml";
+    TestDataFile testFile(testFileName);
+    Manifest manifest = YamlParser::CreateFromPath(testFile);
+
+    // Update the installer path for testing
+    REQUIRE(1 == manifest.Installers.size());
+    TestDataFile msixFile(manifest.Installers[0].Url.c_str());
+    manifest.Installers[0].Url = msixFile.GetPath().u8string();
+
+    auto errors = ValidateManifestInstallers(manifest);
+    REQUIRE(1 == errors.size());
+
+    REQUIRE(ValidationError::Level::Error == errors[0].ErrorLevel);
+    REQUIRE(ManifestError::NoSupportedPlatforms == errors[0].Message);
+    REQUIRE("InstallerUrl" == errors[0].Field);
+    REQUIRE(manifest.Installers.front().Url == errors[0].Value);
+}
+
 TEST_CASE("ReadManifestAndValidateMsixInstallers_MissingFields", "[ManifestValidation]")
 {
     TestDataFile testFile("Manifest-Bad-MissingMsixInstallerFields.yaml");

src/AppInstallerCommonCore/Manifest/ManifestValidation.cpp

@@ -298,15 +298,15 @@ namespace AppInstaller::Manifest
             // Validate package family name
             auto msixManifestIdentity = msixManifest.GetIdentity();
             auto msixPackageFamilyName = msixManifestIdentity.GetPackageFamilyName();
-            if (!installer.PackageFamilyName.empty() && !msixPackageFamilyName.empty())
+            if (!installer.PackageFamilyName.empty())
             {
                 if (installer.PackageFamilyName != msixPackageFamilyName)
                 {
                     errors.emplace_back(ManifestError::InstallerMsixInconsistencies, "PackageFamilyName", msixPackageFamilyName);
                 }
             }
             // Yaml manifest missing package family name
-            else if (!msixPackageFamilyName.empty())
+            else
             {
                 errors.emplace_back(
                     ManifestError::OptionalFieldMissing,
@@ -322,30 +322,27 @@ namespace AppInstaller::Manifest
                 errors.emplace_back(ManifestError::InstallerMsixInconsistencies, "PackageVersion", msixVersion.ToString());
             }
 
-            try
+            // Validate min OS version
+            auto targetMinOSVersion = msixManifest.GetMinimumOSVersionForSupportedPlatforms();
+            if (targetMinOSVersion.has_value() && installerMinOSVersion.has_value())
             {
-                // Validate min OS version
-                auto targetMinOSVersion = msixManifest.GetMinimumOSVersion();
-                if (installerMinOSVersion.has_value())
-                {
-                    if (targetMinOSVersion != installerMinOSVersion.value())
-                    {
-                        errors.emplace_back(ManifestError::InstallerMsixInconsistencies, "MinimumOSVersion", targetMinOSVersion.ToString());
-                    }
-                }
-                // Yaml manifest missing min OS version
-                else
+                if (targetMinOSVersion.value() != installerMinOSVersion.value())
                 {
-                    errors.emplace_back(
-                        ManifestError::OptionalFieldMissing,
-                        "MinimumOSVersion",
-                        targetMinOSVersion.ToString(),
-                        treatErrorAsWarning ? ValidationError::Level::Warning : ValidationError::Level::Error);
+                    errors.emplace_back(ManifestError::InstallerMsixInconsistencies, "MinimumOSVersion", targetMinOSVersion.value().ToString());
                 }
             }
-            catch (...)
+            // Yaml manifest missing min OS version
+            else if(targetMinOSVersion.has_value())
+            {
+                errors.emplace_back(
+                    ManifestError::OptionalFieldMissing,
+                    "MinimumOSVersion",
+                    targetMinOSVersion.value().ToString(),
+                    treatErrorAsWarning ? ValidationError::Level::Warning : ValidationError::Level::Error);
+            }
+            else
             {
-                errors.emplace_back(ManifestError::NoSuitablePlatform, "InstallerUrl", installer.Url);
+                errors.emplace_back(ManifestError::NoSupportedPlatforms, "InstallerUrl", installer.Url);
             }
         }
 

src/AppInstallerCommonCore/MsixManifest.cpp

@@ -29,36 +29,28 @@ namespace AppInstaller::Msix
         return MsixPackageManifestIdentity{ std::move(manifestPackageId) };
     }
 
-    OSVersion MsixPackageManifest::GetMinimumOSVersion() const
+    std::optional<OSVersion> MsixPackageManifest::GetMinimumOSVersionForSupportedPlatforms() const
     {
         std::optional<OSVersion> minOSVersion;
         auto targetDeviceFamilies = GetTargetDeviceFamilies();
+        std::map<MsixPackageManifestTargetDeviceFamily::Platform, OSVersion> targetOSVersion;
 
         for (const auto& targetDeviceFamily : targetDeviceFamilies)
         {
-            auto platform = targetDeviceFamily.GetPlatform();
-            auto minVersion = targetDeviceFamily.GetMinVersion();
-            if (platform == MsixPackageManifestTargetDeviceFamily::Platform::WindowsDesktop)
-            {
-                return minVersion;
-            }
-
-            if (platform == MsixPackageManifestTargetDeviceFamily::Platform::WindowsUniversal)
-            {
-                minOSVersion = minVersion;
-            }
+            targetOSVersion.emplace(targetDeviceFamily.GetPlatform(), targetDeviceFamily.GetMinVersion());
         }
 
-        // If target device family "Windows.Desktop" was not present,
-        // get minimum OS version from "Windows.Universal"
-        if (minOSVersion.has_value())
+        if (targetOSVersion.find(MsixPackageManifestTargetDeviceFamily::Platform::WindowsDesktop) != targetOSVersion.end())
         {
-            return minOSVersion.value();
+            return targetOSVersion[MsixPackageManifestTargetDeviceFamily::Platform::WindowsDesktop];
         }
 
-        // Can't get min OS version because none of the provided
-        // target device family names are supported
-        THROW_HR(E_UNEXPECTED);
+        if (targetOSVersion.find(MsixPackageManifestTargetDeviceFamily::Platform::WindowsUniversal) != targetOSVersion.end())
+        {
+            return targetOSVersion[MsixPackageManifestTargetDeviceFamily::Platform::WindowsUniversal];
+        }
+
+        return std::nullopt;
     }
 
     std::vector<MsixPackageManifestTargetDeviceFamily> MsixPackageManifest::GetTargetDeviceFamilies() const

src/AppInstallerCommonCore/Public/winget/ManifestValidation.h

@@ -54,7 +54,7 @@ namespace AppInstaller::Manifest
         const char* const InstallerMsixInconsistencies = "Inconsistent value in the manifest.";
         const char* const OptionalFieldMissing = "Optional field missing.";
         const char* const InstallerFailedToProcess = "Failed to process installer.";
-        const char* const NoSuitablePlatform = "No Suitable Platform.";
+        const char* const NoSupportedPlatforms = "No supported platforms.";
         const char* const ApproximateVersionNotAllowed = "Approximate version not allowed.";
         const char* const ArpVersionOverlapWithIndex = "DisplayVersion declared in the manifest has overlap with existing DisplayVersion range in the index. Existing DisplayVersion range in index: ";
         const char* const ArpVersionValidationInternalError = "Internal error while validating DisplayVersion against index.";

src/AppInstallerCommonCore/Public/winget/MsixManifest.h

@@ -57,7 +57,7 @@ namespace AppInstaller::Msix
 
         std::vector<MsixPackageManifestTargetDeviceFamily> GetTargetDeviceFamilies() const;
         MsixPackageManifestIdentity GetIdentity() const;
-        OSVersion GetMinimumOSVersion() const;
+        std::optional<OSVersion> GetMinimumOSVersionForSupportedPlatforms() const;
     private:
         Microsoft::WRL::ComPtr<IAppxManifestReader> m_manifestReader;
     };