Skip stub packages for msix installer validation (#3468)

microsoft · Jul 25, 2023 · 3be680c · 3be680c
1 parent f6e453e
commit 3be680c
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 8 deletions.
diff --git a/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj b/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj
@@ -817,6 +817,9 @@
     <CopyFileToFolders Include="TestData\Installer-Good.msixbundle">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Installer-Good-WithStub.msixbundle">
+      <DeploymentContent>true</DeploymentContent>
+    </CopyFileToFolders>
     <CopyFileToFolders Include="TestData\Installer-Signed-Good.msix">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>
@@ -832,6 +835,9 @@
     <CopyFileToFolders Include="TestData\Manifest-Good-MsixBundleInstaller.yaml">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Manifest-Good-MsixBundleInstaller-WithStub.yaml">
+      <DeploymentContent>true</DeploymentContent>
+    </CopyFileToFolders>
     <CopyFileToFolders Include="TestData\Manifest-Bad-InconsistentMsixBundleInstallerFields.yaml">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>

diff --git a/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj.filters b/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj.filters
@@ -852,6 +852,9 @@
     <CopyFileToFolders Include="TestData\Installer-Good.msixbundle">
       <Filter>TestData</Filter>
     </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Installer-Good-WithStub.msixbundle">
+      <Filter>TestData</Filter>
+    </CopyFileToFolders>
     <CopyFileToFolders Include="TestData\Installer-Signed-Good.msix">
       <Filter>TestData</Filter>
     </CopyFileToFolders>
@@ -867,6 +870,9 @@
     <CopyFileToFolders Include="TestData\Manifest-Good-MsixBundleInstaller.yaml">
       <Filter>TestData</Filter>
     </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\Manifest-Good-MsixBundleInstaller-WithStub.yaml">
+      <Filter>TestData</Filter>
+    </CopyFileToFolders>
     <CopyFileToFolders Include="TestData\Manifest-Bad-InconsistentMsixBundleInstallerFields.yaml">
       <Filter>TestData</Filter>
     </CopyFileToFolders>

diff --git a/src/AppInstallerCLITests/TestData/Installer-Good-WithStub.msixbundle b/src/AppInstallerCLITests/TestData/Installer-Good-WithStub.msixbundle
diff --git a/src/AppInstallerCLITests/TestData/Manifest-Good-MsixBundleInstaller-WithStub.yaml b/src/AppInstallerCLITests/TestData/Manifest-Good-MsixBundleInstaller-WithStub.yaml
@@ -0,0 +1,13 @@
+PackageIdentifier: AppInstallerCliTest.GoodMsixBundleInstaller
+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-Good-WithStub.msixbundle
+ManifestType: merged
+ManifestVersion: 1.0.0
diff --git a/src/AppInstallerCLITests/YamlManifest.cpp b/src/AppInstallerCLITests/YamlManifest.cpp
@@ -1150,6 +1150,20 @@ TEST_CASE("ReadManifestAndValidateMsixBundleInstallers_Success", "[ManifestValid
     REQUIRE(0 == errors.size());
 }
 
+TEST_CASE("ReadManifestAndValidateMsixBundleInstallers_WithStub_Success", "[ManifestValidation]")
+{
+    TestDataFile testFile("Manifest-Good-MsixBundleInstaller-WithStub.yaml");
+    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(0 == errors.size());
+}
+
 TEST_CASE("ReadManifestAndValidateMsixBundleInstallers_InconsistentFields", "[ManifestValidation]")
 {
     TestDataFile testFile("Manifest-Bad-InconsistentMsixBundleInstallerFields.yaml");

diff --git a/src/AppInstallerCommonCore/MsixInfo.cpp b/src/AppInstallerCommonCore/MsixInfo.cpp
@@ -623,7 +623,7 @@ namespace AppInstaller::Msix
         return Utility::ConvertToUTF8(GetPackageFullNameWide());
     }
 
-    std::vector<ComPtr<IAppxPackageReader>> MsixInfo::GetAppPackages() const
+    std::vector<ComPtr<IAppxPackageReader>> MsixInfo::GetAppPackages(bool includeStub) const
     {
         if (!m_isBundle)
         {
@@ -648,11 +648,19 @@ namespace AppInstaller::Msix
             APPX_BUNDLE_PAYLOAD_PACKAGE_TYPE packageType;
             THROW_IF_FAILED(packageInfo->GetPackageType(&packageType));
 
+            // Check flat bundle case.
             UINT64 offset;
             THROW_IF_FAILED(packageInfo->GetOffset(&offset));
-            const bool isContained = offset != 0;
+            bool isContained = offset != 0;
 
-            if (isContained && packageType == APPX_BUNDLE_PAYLOAD_PACKAGE_TYPE::APPX_BUNDLE_PAYLOAD_PACKAGE_TYPE_APPLICATION)
+            // Check stub package case.
+            ComPtr<IAppxBundleManifestPackageInfo4> packageInfo4;
+            THROW_IF_FAILED(packageInfo.As(&packageInfo4));
+            BOOL isStub = FALSE;
+            THROW_IF_FAILED(packageInfo4->GetIsStub(&isStub));
+
+            if (isContained && (includeStub || !isStub) &&
+                packageType == APPX_BUNDLE_PAYLOAD_PACKAGE_TYPE::APPX_BUNDLE_PAYLOAD_PACKAGE_TYPE_APPLICATION)
             {
                 wil::unique_cotaskmem_string fileName;
                 THROW_IF_FAILED(packageInfo->GetFileName(&fileName));
@@ -680,10 +688,10 @@ namespace AppInstaller::Msix
         return packages;
     }
 
-    std::vector<MsixPackageManifest> MsixInfo::GetAppPackageManifests() const
+    std::vector<MsixPackageManifest> MsixInfo::GetAppPackageManifests(bool includeStub) const
     {
         std::vector<MsixPackageManifest> manifests;
-        auto packages = GetAppPackages();
+        auto packages = GetAppPackages(includeStub);
         for (const auto& package : packages)
         {
             ComPtr<IAppxManifestReader> manifestReader;

diff --git a/src/AppInstallerCommonCore/Public/AppInstallerMsixInfo.h b/src/AppInstallerCommonCore/Public/AppInstallerMsixInfo.h
@@ -91,16 +91,16 @@ namespace AppInstaller::Msix
         void WriteToFileHandle(std::string_view packageFile, HANDLE target, IProgressCallback& progress);
 
         // Get application package manifests from msix and msixbundle.
-        std::vector<MsixPackageManifest> GetAppPackageManifests() const;
+        std::vector<MsixPackageManifest> GetAppPackageManifests(bool includeStub = false) const;
 
     private:
         bool m_isBundle;
         Microsoft::WRL::ComPtr<IStream> m_stream;
         Microsoft::WRL::ComPtr<IAppxBundleReader> m_bundleReader;
         Microsoft::WRL::ComPtr<IAppxPackageReader> m_packageReader;
 
-        // Get application packages.
-        std::vector<Microsoft::WRL::ComPtr<IAppxPackageReader>> GetAppPackages() const;
+        // Get application packages. Ignore stub packages if any.
+        std::vector<Microsoft::WRL::ComPtr<IAppxPackageReader>> GetAppPackages(bool includeStub = false) const;
     };
 
     struct GetCertContextResult