skip validation for non-yaml format

mdanish-kh · mdanish-kh · commit f48d8b7f7240 · 2025-04-01T20:38:54.000+05:00
diff --git a/src/WingetCreateCLI/Commands/BaseCommand.cs b/src/WingetCreateCLI/Commands/BaseCommand.cs
@@ -216,8 +216,9 @@ protected static string SaveManifestDirToLocalPath(
         /// Saves the manifests to a randomly generated directory in the %TEMP% folder and validates them, printing the results to console.
         /// </summary>
         /// <param name="manifests">Manifests object model.</param>
+        /// <param name="format">Format of the serialized manifest. </param>
         /// <returns>A boolean value indicating whether validation of the manifests was successful.</returns>
-        protected static bool ValidateManifestsInTempDir(Manifests manifests)
+        protected static bool ValidateManifestsInTempDir(Manifests manifests, ManifestFormat format)
         {
             string versionManifestFileName = Manifests.GetFileName(manifests.VersionManifest, Extension);
             string installerManifestFileName = Manifests.GetFileName(manifests.InstallerManifest, Extension);
@@ -236,7 +237,7 @@ protected static bool ValidateManifestsInTempDir(Manifests manifests)
                 File.WriteAllText(Path.Combine(randomDirPath, localeManifestFileName), localeManifest.ToManifestString());
             }
 
-            bool result = ValidateManifest(randomDirPath);
+            bool result = ValidateManifest(randomDirPath, format);
             Directory.Delete(randomDirPath, true);
             return result;
         }
@@ -382,9 +383,18 @@ protected static async Task<string> DownloadPackageFile(string installerUrl)
         /// Utilizes WingetUtil to validate a specified manifest.
         /// </summary>
         /// <param name="manifestPath"> Path to the manifest file to be validated. </param>
+        /// <param name="format"> Format of the manifest file. </param>"
         /// <returns>Bool indicating the validity of the manifest file. </returns>
-        protected static bool ValidateManifest(string manifestPath)
+        protected static bool ValidateManifest(string manifestPath, ManifestFormat format)
         {
+            bool skipValidation = format != ManifestFormat.Yaml;
+
+            if (skipValidation)
+            {
+                Logger.WarnLocalized(nameof(Resources.SkippingManifestValidation_Message));
+                return true;
+            }
+
             (bool success, string message) = WinGetUtil.ValidateManifest(manifestPath);
 
             if (success)
diff --git a/src/WingetCreateCLI/Commands/NewCommand.cs b/src/WingetCreateCLI/Commands/NewCommand.cs
@@ -261,7 +261,7 @@ public override async Task<bool> Execute()
                     ShiftInstallerFieldsToRootLevel(manifests.InstallerManifest);
                     RemoveEmptyStringAndListFieldsInManifests(manifests);
                     DisplayManifestPreview(manifests);
-                    isManifestValid = ValidateManifestsInTempDir(manifests);
+                    isManifestValid = ValidateManifestsInTempDir(manifests, this.Format);
                 }
                 while (Prompt.Confirm(Resources.ConfirmManifestCreation_Message));
 
diff --git a/src/WingetCreateCLI/Commands/NewLocaleCommand.cs b/src/WingetCreateCLI/Commands/NewLocaleCommand.cs
@@ -224,7 +224,7 @@ public override async Task<bool> Execute()
                 {
                     LocaleManifest newlocale = this.GenerateLocaleManifest(originalManifests, referenceLocaleManifest);
                     Console.WriteLine();
-                    ValidateManifestsInTempDir(originalManifests);
+                    ValidateManifestsInTempDir(originalManifests, this.Format);
                     originalManifests.LocaleManifests.Add(newlocale);
                     newLocales.Add(newlocale);
                 }
@@ -241,7 +241,7 @@ public override async Task<bool> Execute()
 
                 string manifestDirectoryPath = SaveManifestDirToLocalPath(originalManifests, this.OutputDir);
 
-                if (ValidateManifest(manifestDirectoryPath))
+                if (ValidateManifest(manifestDirectoryPath, this.Format))
                 {
                     if (Prompt.Confirm(Resources.ConfirmGitHubSubmitManifest_Message))
                     {
diff --git a/src/WingetCreateCLI/Commands/SubmitCommand.cs b/src/WingetCreateCLI/Commands/SubmitCommand.cs
@@ -112,7 +112,7 @@ private async Task<bool> SubmitManifest()
             string expandedPath = System.Environment.ExpandEnvironmentVariables(this.Path);
 
             // TODO: Remove singleton support.
-            if (File.Exists(expandedPath) && ValidateManifest(expandedPath))
+            if (File.Exists(expandedPath) && ValidateManifest(expandedPath, this.Format))
             {
                 Manifests manifests = new Manifests();
                 manifests.SingletonManifest = Serialization.DeserializeFromPath<SingletonManifest>(expandedPath);
@@ -124,7 +124,7 @@ private async Task<bool> SubmitManifest()
 
                 return await this.GitHubSubmitManifests(manifests, this.PRTitle, this.Replace, this.ReplaceVersion);
             }
-            else if (Directory.Exists(expandedPath) && ValidateManifest(expandedPath))
+            else if (Directory.Exists(expandedPath) && ValidateManifest(expandedPath, this.Format))
             {
                 List<string> manifestContents = Directory.GetFiles(expandedPath).Select(f => File.ReadAllText(f)).ToList();
                 Manifests manifests = Serialization.DeserializeManifestContents(manifestContents);
diff --git a/src/WingetCreateCLI/Commands/UpdateCommand.cs b/src/WingetCreateCLI/Commands/UpdateCommand.cs
@@ -274,7 +274,7 @@ await this.UpdateManifestsInteractively(initialManifests) :
 
             string manifestDirectoryPath = SaveManifestDirToLocalPath(updatedManifests, this.OutputDir);
 
-            if (ValidateManifest(manifestDirectoryPath))
+            if (ValidateManifest(manifestDirectoryPath, this.Format))
             {
                 if (this.SubmitToGitHub)
                 {
@@ -687,7 +687,7 @@ private static bool VerifyUpdatedInstallerHash(Manifests oldManifest, InstallerM
             return newHashes.Except(oldHashes).Any();
         }
 
-        private static void DisplayManifestsAsMenuSelection(Manifests manifests)
+        private static void DisplayManifestsAsMenuSelection(Manifests manifests, ManifestFormat format)
         {
             Console.Clear();
             string versionFileName = Manifests.GetFileName(manifests.VersionManifest, Extension);
@@ -709,7 +709,7 @@ private static void DisplayManifestsAsMenuSelection(Manifests manifests)
                 }
 
                 selectionList.Add(Resources.Done_MenuItem);
-                ValidateManifestsInTempDir(manifests);
+                ValidateManifestsInTempDir(manifests, format);
                 var selectedItem = Prompt.Select(Resources.SelectManifestToEdit_Message, selectionList);
 
                 if (selectedItem == versionManifestMenuItem)
@@ -956,13 +956,13 @@ private async Task<Manifests> UpdateManifestsInteractively(Manifests manifests)
 
                 this.AddVersionSpecificMetadata(manifests);
                 DisplayManifestPreview(manifests);
-                ValidateManifestsInTempDir(manifests);
+                ValidateManifestsInTempDir(manifests, this.Format);
             }
             while (Prompt.Confirm(Resources.DiscardUpdateAndStartOver_Message));
 
             if (Prompt.Confirm(Resources.EditManifests_Message))
             {
-                DisplayManifestsAsMenuSelection(manifests);
+                DisplayManifestsAsMenuSelection(manifests, this.Format);
             }
 
             if (!this.SubmitToGitHub)
diff --git a/src/WingetCreateCLI/Commands/UpdateLocaleCommand.cs b/src/WingetCreateCLI/Commands/UpdateLocaleCommand.cs
@@ -172,7 +172,7 @@ public override async Task<bool> Execute()
 
                 string manifestDirectoryPath = SaveManifestDirToLocalPath(originalManifests, this.OutputDir);
 
-                if (ValidateManifest(manifestDirectoryPath))
+                if (ValidateManifest(manifestDirectoryPath, this.Format))
                 {
                     if (Prompt.Confirm(Resources.ConfirmGitHubSubmitManifest_Message))
                     {
@@ -281,7 +281,7 @@ private Tuple<DefaultLocaleManifest, List<LocaleManifest>> PromptAndUpdateExisti
                 }
 
                 Console.WriteLine();
-                ValidateManifestsInTempDir(manifests);
+                ValidateManifestsInTempDir(manifests, this.Format);
             }
             while (Prompt.Confirm(Resources.UpdateAnotherLocale_Message));
 
diff --git a/src/WingetCreateCLI/Properties/Resources.Designer.cs b/src/WingetCreateCLI/Properties/Resources.Designer.cs
diff --git a/src/WingetCreateCLI/Properties/Resources.resx b/src/WingetCreateCLI/Properties/Resources.resx
@@ -1418,4 +1418,7 @@ Warning: Using this argument may result in the token being logged. Consider an a
   <data name="Authentication_KeywordDescription" xml:space="preserve">
     <value>Authentication information for Entra Id secured private sources</value>
   </data>
+  <data name="SkippingManifestValidation_Message" xml:space="preserve">
+    <value>Skipping manifest validation. The CLI can only validate YAML format. Validate output manually before submission.</value>
+  </data>
 </root>
diff --git a/src/WingetCreateTests/WingetCreateTests/E2ETests/E2ETests.cs b/src/WingetCreateTests/WingetCreateTests/E2ETests/E2ETests.cs
@@ -9,6 +9,7 @@ namespace Microsoft.WingetCreateE2ETests
     using Microsoft.WingetCreateCLI.Commands;
     using Microsoft.WingetCreateCLI.Logging;
     using Microsoft.WingetCreateCLI.Models.Settings;
+    using Microsoft.WingetCreateCLI.Properties;
     using Microsoft.WingetCreateCore;
     using Microsoft.WingetCreateCore.Common;
     using Microsoft.WingetCreateTests;
@@ -27,6 +28,7 @@ public class E2ETests : GitHubTestsBase
     {
         private const string PackageVersion = "1.2.3.4";
         private GitHub gitHub;
+        private StringWriter sw;
 
         /// <summary>
         /// One-time function that runs at the beginning of this test class.
@@ -37,6 +39,8 @@ public void Setup()
             Logger.Initialize();
             this.gitHub = new GitHub(this.GitHubApiKey, this.WingetPkgsTestRepoOwner, this.WingetPkgsTestRepo);
             TestUtils.InitializeMockDownload();
+            this.sw = new StringWriter();
+            Console.SetOut(this.sw);
         }
 
         /// <summary>
@@ -54,12 +58,12 @@ public void Setup()
         [TestCase(TestConstants.YamlConstants.TestPortablePackageIdentifier, TestConstants.YamlConstants.TestPortableManifest, TestConstants.TestExeInstaller, TestConstants.YamlManifestFormat)]
         [TestCase(TestConstants.YamlConstants.TestZipPackageIdentifier, TestConstants.YamlConstants.TestZipManifest, TestConstants.TestZipInstaller, TestConstants.YamlManifestFormat)]
 
-        // JSON E2E Tests. Skipped because of https://github.com/microsoft/winget-cli/issues/5336
-        [TestCase(TestConstants.JsonConstants.TestExePackageIdentifier, TestConstants.JsonConstants.TestExeManifest, TestConstants.TestExeInstaller, TestConstants.JsonManifestFormat, Ignore = "Fails WinGetUtil.WinGetValidateManifest in schema version 1.10.0+")]
-        [TestCase(TestConstants.JsonConstants.TestMsiPackageIdentifier, TestConstants.JsonConstants.TestMsiManifest, TestConstants.TestMsiInstaller, TestConstants.JsonManifestFormat, Ignore = "Fails WinGetUtil.WinGetValidateManifest in schema version 1.10.0+")]
-        [TestCase(TestConstants.JsonConstants.TestMultifileMsixPackageIdentifier, TestConstants.JsonConstants.TestMultifileMsixManifestDir, TestConstants.TestMsixInstaller, TestConstants.JsonManifestFormat, Ignore = "Fails WinGetUtil.WinGetValidateManifest in schema version 1.10.0+")]
-        [TestCase(TestConstants.JsonConstants.TestPortablePackageIdentifier, TestConstants.JsonConstants.TestPortableManifest, TestConstants.TestExeInstaller, TestConstants.JsonManifestFormat, Ignore = "Fails WinGetUtil.WinGetValidateManifest in schema version 1.10.0+")]
-        [TestCase(TestConstants.JsonConstants.TestZipPackageIdentifier, TestConstants.JsonConstants.TestZipManifest, TestConstants.TestZipInstaller, TestConstants.JsonManifestFormat, Ignore = "Fails WinGetUtil.WinGetValidateManifest in schema version 1.10.0+")]
+        // JSON E2E Tests
+        [TestCase(TestConstants.JsonConstants.TestExePackageIdentifier, TestConstants.JsonConstants.TestExeManifest, TestConstants.TestExeInstaller, TestConstants.JsonManifestFormat)]
+        [TestCase(TestConstants.JsonConstants.TestMsiPackageIdentifier, TestConstants.JsonConstants.TestMsiManifest, TestConstants.TestMsiInstaller, TestConstants.JsonManifestFormat)]
+        [TestCase(TestConstants.JsonConstants.TestMultifileMsixPackageIdentifier, TestConstants.JsonConstants.TestMultifileMsixManifestDir, TestConstants.TestMsixInstaller, TestConstants.JsonManifestFormat)]
+        [TestCase(TestConstants.JsonConstants.TestPortablePackageIdentifier, TestConstants.JsonConstants.TestPortableManifest, TestConstants.TestExeInstaller, TestConstants.JsonManifestFormat)]
+        [TestCase(TestConstants.JsonConstants.TestZipPackageIdentifier, TestConstants.JsonConstants.TestZipManifest, TestConstants.TestZipInstaller, TestConstants.JsonManifestFormat)]
 
         public async Task SubmitAndUpdateInstaller(string packageId, string manifestName, string installerName, ManifestFormat format)
         {
@@ -86,6 +90,10 @@ private async Task RunSubmitAndUpdateFlow(string packageId, string manifestPath,
                 OpenPRInBrowser = false,
             };
             ClassicAssert.IsTrue(await submitCommand.Execute(), "Command should have succeeded");
+            this.AssertValidationOutput(format);
+
+            // Clear output for the next command
+            this.sw.GetStringBuilder().Clear();
 
             var mergeRetryPolicy = Policy
                 .Handle<PullRequestNotMergeableException>()
@@ -115,11 +123,22 @@ await mergeRetryPolicy.ExecuteAsync(async () =>
             ClassicAssert.IsTrue(await updateCommand.LoadGitHubClient(), "Failed to create GitHub client");
             ClassicAssert.IsTrue(await updateCommand.Execute(), "Command should execute successfully");
 
-            string pathToValidate = Path.Combine(Directory.GetCurrentDirectory(), Utils.GetAppManifestDirPath(packageId, PackageVersion));
-            (bool success, string message) = WinGetUtil.ValidateManifest(pathToValidate);
-            ClassicAssert.IsTrue(success, message);
-
+            // Since SubmitToGitHub is true, the command will first validate the manifest & then submit the PR
+            this.AssertValidationOutput(format);
             await this.gitHub.ClosePullRequest(updateCommand.PullRequestNumber);
         }
+
+        private void AssertValidationOutput(ManifestFormat format)
+        {
+            string output = this.sw.ToString();
+            if (format == ManifestFormat.Yaml)
+            {
+                Assert.That(output, Does.Contain(string.Format(Resources.ManifestValidationSucceeded_Message, true)), "Manifest validation success message should be shown");
+            }
+            else
+            {
+                Assert.That(output, Does.Contain(Resources.SkippingManifestValidation_Message), "Skipping manifest validation message should be shown");
+            }
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -261,7 +261,7 @@ public override async Task<bool> Execute()`
`261`	`261`	`ShiftInstallerFieldsToRootLevel(manifests.InstallerManifest);`
`262`	`262`	`RemoveEmptyStringAndListFieldsInManifests(manifests);`
`263`	`263`	`DisplayManifestPreview(manifests);`
`264`		`- isManifestValid = ValidateManifestsInTempDir(manifests);`
	`264`	`+ isManifestValid = ValidateManifestsInTempDir(manifests, this.Format);`
`265`	`265`	`}`
`266`	`266`	`while (Prompt.Confirm(Resources.ConfirmManifestCreation_Message));`
`267`	`267`
Original file line number	Diff line number	Diff line change
`@@ -224,7 +224,7 @@ public override async Task<bool> Execute()`
`224`	`224`	`{`
`225`	`225`	`LocaleManifest newlocale = this.GenerateLocaleManifest(originalManifests, referenceLocaleManifest);`
`226`	`226`	`Console.WriteLine();`
`227`		`- ValidateManifestsInTempDir(originalManifests);`
	`227`	`+ ValidateManifestsInTempDir(originalManifests, this.Format);`
`228`	`228`	`originalManifests.LocaleManifests.Add(newlocale);`
`229`	`229`	`newLocales.Add(newlocale);`
`230`	`230`	`}`
`@@ -241,7 +241,7 @@ public override async Task<bool> Execute()`
`241`	`241`
`242`	`242`	`string manifestDirectoryPath = SaveManifestDirToLocalPath(originalManifests, this.OutputDir);`
`243`	`243`
`244`		`- if (ValidateManifest(manifestDirectoryPath))`
	`244`	`+ if (ValidateManifest(manifestDirectoryPath, this.Format))`
`245`	`245`	`{`
`246`	`246`	`if (Prompt.Confirm(Resources.ConfirmGitHubSubmitManifest_Message))`
`247`	`247`	`{`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ private async Task<bool> SubmitManifest()`
`112`	`112`	`string expandedPath = System.Environment.ExpandEnvironmentVariables(this.Path);`
`113`	`113`
`114`	`114`	`// TODO: Remove singleton support.`
`115`		`- if (File.Exists(expandedPath) && ValidateManifest(expandedPath))`
	`115`	`+ if (File.Exists(expandedPath) && ValidateManifest(expandedPath, this.Format))`
`116`	`116`	`{`
`117`	`117`	`Manifests manifests = new Manifests();`
`118`	`118`	`manifests.SingletonManifest = Serialization.DeserializeFromPath<SingletonManifest>(expandedPath);`
`@@ -124,7 +124,7 @@ private async Task<bool> SubmitManifest()`
`124`	`124`
`125`	`125`	`return await this.GitHubSubmitManifests(manifests, this.PRTitle, this.Replace, this.ReplaceVersion);`
`126`	`126`	`}`
`127`		`- else if (Directory.Exists(expandedPath) && ValidateManifest(expandedPath))`
	`127`	`+ else if (Directory.Exists(expandedPath) && ValidateManifest(expandedPath, this.Format))`
`128`	`128`	`{`
`129`	`129`	`List<string> manifestContents = Directory.GetFiles(expandedPath).Select(f => File.ReadAllText(f)).ToList();`
`130`	`130`	`Manifests manifests = Serialization.DeserializeManifestContents(manifestContents);`
Original file line number	Diff line number	Diff line change
`@@ -274,7 +274,7 @@ await this.UpdateManifestsInteractively(initialManifests) :`
`274`	`274`
`275`	`275`	`string manifestDirectoryPath = SaveManifestDirToLocalPath(updatedManifests, this.OutputDir);`
`276`	`276`
`277`		`- if (ValidateManifest(manifestDirectoryPath))`
	`277`	`+ if (ValidateManifest(manifestDirectoryPath, this.Format))`
`278`	`278`	`{`
`279`	`279`	`if (this.SubmitToGitHub)`
`280`	`280`	`{`
`@@ -687,7 +687,7 @@ private static bool VerifyUpdatedInstallerHash(Manifests oldManifest, InstallerM`
`687`	`687`	`return newHashes.Except(oldHashes).Any();`
`688`	`688`	`}`
`689`	`689`
`690`		`- private static void DisplayManifestsAsMenuSelection(Manifests manifests)`
	`690`	`+ private static void DisplayManifestsAsMenuSelection(Manifests manifests, ManifestFormat format)`
`691`	`691`	`{`
`692`	`692`	`Console.Clear();`
`693`	`693`	`string versionFileName = Manifests.GetFileName(manifests.VersionManifest, Extension);`
`@@ -709,7 +709,7 @@ private static void DisplayManifestsAsMenuSelection(Manifests manifests)`
`709`	`709`	`}`
`710`	`710`
`711`	`711`	`selectionList.Add(Resources.Done_MenuItem);`
`712`		`- ValidateManifestsInTempDir(manifests);`
	`712`	`+ ValidateManifestsInTempDir(manifests, format);`
`713`	`713`	`var selectedItem = Prompt.Select(Resources.SelectManifestToEdit_Message, selectionList);`
`714`	`714`
`715`	`715`	`if (selectedItem == versionManifestMenuItem)`
`@@ -956,13 +956,13 @@ private async Task<Manifests> UpdateManifestsInteractively(Manifests manifests)`
`956`	`956`
`957`	`957`	`this.AddVersionSpecificMetadata(manifests);`
`958`	`958`	`DisplayManifestPreview(manifests);`
`959`		`- ValidateManifestsInTempDir(manifests);`
	`959`	`+ ValidateManifestsInTempDir(manifests, this.Format);`
`960`	`960`	`}`
`961`	`961`	`while (Prompt.Confirm(Resources.DiscardUpdateAndStartOver_Message));`
`962`	`962`
`963`	`963`	`if (Prompt.Confirm(Resources.EditManifests_Message))`
`964`	`964`	`{`
`965`		`- DisplayManifestsAsMenuSelection(manifests);`
	`965`	`+ DisplayManifestsAsMenuSelection(manifests, this.Format);`
`966`	`966`	`}`
`967`	`967`
`968`	`968`	`if (!this.SubmitToGitHub)`
Original file line number	Diff line number	Diff line change
`@@ -172,7 +172,7 @@ public override async Task<bool> Execute()`
`172`	`172`
`173`	`173`	`string manifestDirectoryPath = SaveManifestDirToLocalPath(originalManifests, this.OutputDir);`
`174`	`174`
`175`		`- if (ValidateManifest(manifestDirectoryPath))`
	`175`	`+ if (ValidateManifest(manifestDirectoryPath, this.Format))`
`176`	`176`	`{`
`177`	`177`	`if (Prompt.Confirm(Resources.ConfirmGitHubSubmitManifest_Message))`
`178`	`178`	`{`
`@@ -281,7 +281,7 @@ private Tuple<DefaultLocaleManifest, List<LocaleManifest>> PromptAndUpdateExisti`
`281`	`281`	`}`
`282`	`282`
`283`	`283`	`Console.WriteLine();`
`284`		`- ValidateManifestsInTempDir(manifests);`
	`284`	`+ ValidateManifestsInTempDir(manifests, this.Format);`
`285`	`285`	`}`
`286`	`286`	`while (Prompt.Confirm(Resources.UpdateAnotherLocale_Message));`
`287`	`287`