Add Nuspec Schema scrubber and add to default scrubbers list (#11)

MattKotsenas · web-flow · commit 1cb49d80f6bc · 2024-03-21T19:06:42.000-07:00
The NuGet client will always use the oldest schema version it can. Additionally, a new schema version was released for SemVer version numbers (i.e. v2 and v3 here: https://github.com/NuGet/NuGet.Client/blob/8c972cdff5b1194d7c37384fca5816a33ffbe0c4/src/NuGet.Core/NuGet.Packaging/PackageCreation/Authoring/ManifestSchemaUtility.cs). The result of these two factors is that a version bump (such as from 1.0.0-deadbeef to 1.0.1) may result in a nuspec diff. Thus scrub the xmlns for the NuSpec schema to reduce the noise in the diff.
diff --git a/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.AddGitExtensionToRepoUrl/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.AddGitExtensionToRepoUrl/manifest.verified.nuspec
@@ -1,4 +1,4 @@
-﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package>
   <metadata>
     <id>SimplePackage</id>
     <version>********</version>
diff --git a/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.DoNotScrubGitExtensionOnRepoUrl/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.DoNotScrubGitExtensionOnRepoUrl/manifest.verified.nuspec
@@ -1,4 +1,4 @@
-﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package>
   <metadata>
     <id>PackageWithRepoGitExtension</id>
     <version>********</version>
diff --git a/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.DoNotScrubNonGitHubDomainRepoUrl/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.DoNotScrubNonGitHubDomainRepoUrl/manifest.verified.nuspec
@@ -1,4 +1,4 @@
-﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package>
   <metadata>
     <id>PackageWithoutRepoGitHubDomain</id>
     <version>********</version>
diff --git a/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.DoNotScrubNonHttpsRepoUrl/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.DoNotScrubNonHttpsRepoUrl/manifest.verified.nuspec
@@ -1,4 +1,4 @@
-﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package>
   <metadata>
     <id>PackageWithoutRepoHttps</id>
     <version>********</version>
diff --git a/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.SkipScrubbingForRepoWithNoCommit/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.SkipScrubbingForRepoWithNoCommit/manifest.verified.nuspec
@@ -1,4 +1,4 @@
-﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package>
   <metadata>
     <id>PackageWithoutRepoUrlOrCommit</id>
     <version>********</version>
diff --git a/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.SkipScrubbingForRepoWithNoUrl/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.SkipScrubbingForRepoWithNoUrl/manifest.verified.nuspec
@@ -1,4 +1,4 @@
-﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package>
   <metadata>
     <id>PackageWithoutRepoUrlOrCommit</id>
     <version>********</version>
diff --git a/Tests/Verify.Nupkg.Tests/SimplePackageTests.BasicTest/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/SimplePackageTests.BasicTest/manifest.verified.nuspec
@@ -1,4 +1,4 @@
-﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package>
   <metadata>
     <id>SimplePackage</id>
     <version>********</version>
diff --git a/Tests/Verify.Nupkg.Tests/SimplePackageTests.CustomFileExclusionTest/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/SimplePackageTests.CustomFileExclusionTest/manifest.verified.nuspec
@@ -1,4 +1,4 @@
-﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package>
   <metadata>
     <id>SimplePackage</id>
     <version>********</version>
diff --git a/Tests/Verify.Nupkg.Tests/SimplePackageTests.OnlyOptInScrubbersRun/contents.verified.txt b/Tests/Verify.Nupkg.Tests/SimplePackageTests.OnlyOptInScrubbersRun/contents.verified.txt
diff --git a/Tests/Verify.Nupkg.Tests/SimplePackageTests.OnlyOptInScrubbersRun/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/SimplePackageTests.OnlyOptInScrubbersRun/manifest.verified.nuspec
diff --git a/Tests/Verify.Nupkg.Tests/SimplePackageTests.cs b/Tests/Verify.Nupkg.Tests/SimplePackageTests.cs
@@ -29,9 +29,11 @@ public Task CustomFileExclusionTest()
     }
 
     [Fact]
-    public Task DoNotScrubVersionTest()
+    public Task OnlyOptInScrubbersRun()
     {
-        // In this test we intentionally _do not_ include the version scrubber
+        // In this test we intentionally _do not_ include these scrubbers:
+        //  - Version
+        //  - Schema
         // to validate that only scrubbers we opt-in to are applied.
 
         VerifySettings settings = new();
diff --git a/Tests/Verify.Nupkg.Tests/VerifyNupkgPackageTests.Baseline/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/VerifyNupkgPackageTests.Baseline/manifest.verified.nuspec
@@ -1,4 +1,4 @@
-﻿<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
+﻿<package>
   <metadata>
     <id>Verify.Nupkg</id>
     <version>********</version>
diff --git a/Verify.Nupkg/SchemaScrubber.cs b/Verify.Nupkg/SchemaScrubber.cs
@@ -0,0 +1,23 @@
+﻿using System.Xml.Linq;
+
+namespace VerifyTests;
+
+internal class SchemaScrubber : NuspecScrubberBase
+{
+    protected override void Scrub(XDocument document)
+    {
+        if (document.Root is null)
+        {
+            return;
+        }
+
+        // Remove namespace declaration from the document
+        document.Root.Attributes().Where(e => e.IsNamespaceDeclaration).Remove();
+
+        // Strip the namespace from the elements that already have it as part of their DOM
+        foreach (var node in document.Root.DescendantsAndSelf())
+        {
+            node.Name = node.Name.LocalName;
+        }
+    }
+}
diff --git a/Verify.Nupkg/VerifySettingsScrubExtensions.cs b/Verify.Nupkg/VerifySettingsScrubExtensions.cs
@@ -19,6 +19,7 @@ public static class VerifySettingsScrubExtensions
     /// <returns>The <see cref="VerifySettings"/> for chaining.</returns>
     public static VerifySettings ScrubNuspec(this VerifySettings settings)
     {
+        settings.ScrubNuspecSchema();
         settings.ScrubNuspecVersion();
         settings.ScrubNuspecCommit();
         settings.ScrubNuspecRepositoryUrl();
@@ -46,6 +47,51 @@ public static SettingsTask ScrubNuspec(this SettingsTask settings)
         return settings;
     }
 
+    /// <summary>
+    /// Scrub the XML schema from the nuspec file.
+    /// </summary>
+    /// <param name="settings">
+    /// The <see cref="VerifierSettings"/> to modify.
+    /// </param>
+    /// <remarks>
+    /// The NuGet client will always use the oldest schema version it can. Additionally, a new schema version was released for
+    /// SemVer version numbers (i.e. v2 and v3 here: https://github.com/NuGet/NuGet.Client/blob/8c972cdff5b1194d7c37384fca5816a33ffbe0c4/src/NuGet.Core/NuGet.Packaging/PackageCreation/Authoring/ManifestSchemaUtility.cs).
+    ///
+    /// The result of these two factors is that a version bump (such as from 1.0.0-deadbeef to 1.0.1) may result in a nuspec diff.
+    /// Thus scrub the xmlns for the NuSpec schema to reduce the noise in the diff.
+    /// </remarks>
+    /// <returns>The <see cref="VerifySettings"/> for chaining.</returns>
+    public static VerifySettings ScrubNuspecSchema(this VerifySettings settings)
+    {
+        if (settings is null) { throw new ArgumentNullException(nameof(settings)); }
+
+        settings.AddScrubber(extension: "nuspec", sb => new SchemaScrubber().Scrub(sb));
+
+        return settings;
+    }
+
+    /// <summary>
+    /// Scrub the XML schema from the nuspec file.
+    /// </summary>
+    /// <param name="settings">
+    /// The <see cref="SettingsTask"/> to modify.
+    /// </param>
+    /// <remarks>
+    /// The NuGet client will always use the oldest schema version it can. Additionally, a new schema version was released for
+    /// SemVer version numbers (i.e. v2 and v3 here: https://github.com/NuGet/NuGet.Client/blob/8c972cdff5b1194d7c37384fca5816a33ffbe0c4/src/NuGet.Core/NuGet.Packaging/PackageCreation/Authoring/ManifestSchemaUtility.cs).
+    ///
+    /// The result of these two factors is that a version bump (such as from 1.0.0-deadbeef to 1.0.1) may result in a nuspec diff.
+    /// As a result, scrub the xmlns schema to reduce the noise in the diff.
+    /// </remarks>
+    /// <returns>The <see cref="SettingsTask"/> for chaining.</returns>
+    public static SettingsTask ScrubNuspecSchema(this SettingsTask settings)
+    {
+        if (settings is null) { throw new ArgumentNullException(nameof(settings)); }
+
+        settings.CurrentSettings.ScrubNuspecSchema();
+        return settings;
+    }
+
     /// <summary>
     /// Scrub the version from the nuspec file.
     /// </summary>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">`
	`1`	`+<package>`
`2`	`2`	`<metadata>`
`3`	`3`	`<id>SimplePackage</id>`
`4`	`4`	`<version>********</version>`