Refactor nuspec scrubbing to use XML parsing (#6)

MattKotsenas · web-flow · commit 0e3a5a146f83 · 2024-02-12T13:45:31.000-08:00
* XML-based scrubbing

* Add test to ensure scrubbers are opt-in

* Add test cases to cover missing attributes for repository scrubbing
diff --git a/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.AddGitExtensionToRepoUrl/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.AddGitExtensionToRepoUrl/manifest.verified.nuspec
@@ -1,5 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
-<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
   <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,5 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
-<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
   <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,5 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
-<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
   <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,5 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
-<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
   <metadata>
     <id>PackageWithoutRepoHttps</id>
     <version>********</version>
diff --git a/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.SkipScrubbingForRepoWithNoCommit/contents.verified.txt b/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.SkipScrubbingForRepoWithNoCommit/contents.verified.txt
@@ -0,0 +1,5 @@
+﻿/
+|-- PackageWithoutRepoUrlOrCommit.nuspec
+|-- lib
+    |-- net8.0
+        |-- PackageWithoutRepoUrlOrCommit.dll
diff --git a/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.SkipScrubbingForRepoWithNoCommit/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.SkipScrubbingForRepoWithNoCommit/manifest.verified.nuspec
@@ -0,0 +1,12 @@
+﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+  <metadata>
+    <id>PackageWithoutRepoUrlOrCommit</id>
+    <version>********</version>
+    <authors>PackageWithoutRepoUrlOrCommit</authors>
+    <description>Package Description</description>
+    <repository type="git" />
+    <dependencies>
+      <group targetFramework="net8.0" />
+    </dependencies>
+  </metadata>
+</package>
diff --git a/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.SkipScrubbingForRepoWithNoUrl/contents.verified.txt b/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.SkipScrubbingForRepoWithNoUrl/contents.verified.txt
@@ -0,0 +1,5 @@
+﻿/
+|-- PackageWithoutRepoUrlOrCommit.nuspec
+|-- lib
+    |-- net8.0
+        |-- PackageWithoutRepoUrlOrCommit.dll
diff --git a/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.SkipScrubbingForRepoWithNoUrl/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.SkipScrubbingForRepoWithNoUrl/manifest.verified.nuspec
@@ -0,0 +1,12 @@
+﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+  <metadata>
+    <id>PackageWithoutRepoUrlOrCommit</id>
+    <version>********</version>
+    <authors>PackageWithoutRepoUrlOrCommit</authors>
+    <description>Package Description</description>
+    <repository type="git" />
+    <dependencies>
+      <group targetFramework="net8.0" />
+    </dependencies>
+  </metadata>
+</package>
diff --git a/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.cs b/Tests/Verify.Nupkg.Tests/NuspecScrubbingTests.cs
@@ -6,6 +6,8 @@ public class NuspecScrubbingTests
     private string _packageWithoutRepoGitExtension = SamplePackages.Instance.PackageWithoutRepoGitExtension.Value.FullName;
     private string _packageWithoutRepoHttps = SamplePackages.Instance.PackageWithoutRepoHttps.Value.FullName;
     private string _packageWithoutRepoGitHubDomain = SamplePackages.Instance.PackageWithoutRepoGitHubDomain.Value.FullName;
+    private string _packageWithoutRepoUrl = SamplePackages.Instance.PackageWithoutRepoUrl.Value.FullName;
+    private string _packageWithoutRepoCommit = SamplePackages.Instance.PackageWithoutRepoCommit.Value.FullName;
 
     [Fact]
     public Task DoNotScrubGitExtensionOnRepoUrl()
@@ -46,4 +48,24 @@ public Task DoNotScrubNonGitHubDomainRepoUrl()
 
         return VerifyFile(_packageWithoutRepoGitHubDomain, settings);
     }
+
+    [Fact]
+    public Task SkipScrubbingForRepoWithNoCommit()
+    {
+        VerifySettings settings = new();
+        settings.UseUniqueDirectory();
+        settings.ScrubNuspec();
+
+        return VerifyFile(_packageWithoutRepoCommit, settings);
+    }
+
+    [Fact]
+    public Task SkipScrubbingForRepoWithNoUrl()
+    {
+        VerifySettings settings = new();
+        settings.UseUniqueDirectory();
+        settings.ScrubNuspec();
+
+        return VerifyFile(_packageWithoutRepoUrl, settings);
+    }
 }
diff --git a/Tests/Verify.Nupkg.Tests/SamplePackages/PackageWithoutRepoHttps.cs b/Tests/Verify.Nupkg.Tests/SamplePackages/PackageWithoutRepoHttps.cs
@@ -16,3 +16,15 @@ protected override ProjectCreator CreateCore(IDirectoryInfo workingDirectory)
             .Property("RepositoryCommit", "0e4d1b598f350b3dc675018d539114d1328189ef");
     }
 }
+
+internal class PackageWithoutRepoUrlOrCommit : PackageCreator
+{
+    public override string Name => GetType().Name;
+
+    protected override ProjectCreator CreateCore(IDirectoryInfo workingDirectory)
+    {
+        return ProjectCreator.Templates.SdkCsproj()
+            .Property("TargetFramework", "net8.0")
+            .Property("RepositoryType", "git");
+    }
+}
diff --git a/Tests/Verify.Nupkg.Tests/SamplePackages/SamplePackages.cs b/Tests/Verify.Nupkg.Tests/SamplePackages/SamplePackages.cs
@@ -16,6 +16,8 @@ internal class SamplePackages
     public Lazy<IFileInfo> PackageWithoutRepoGitExtension { get; private set; }
     public Lazy<IFileInfo> PackageWithoutRepoHttps { get; private set; }
     public Lazy<IFileInfo> PackageWithoutRepoGitHubDomain { get; private set; }
+    public Lazy<IFileInfo> PackageWithoutRepoUrl { get; private set; }
+    public Lazy<IFileInfo> PackageWithoutRepoCommit { get; private set; }
 
     private SamplePackages()
     {
@@ -26,6 +28,8 @@ private SamplePackages()
         PackageWithoutRepoGitExtension = SimplePackage;
         PackageWithoutRepoHttps = new Lazy<IFileInfo>(() => new PackageWithoutRepoHttps().Create(workingDirectory));
         PackageWithoutRepoGitHubDomain = new Lazy<IFileInfo>(() => new PackageWithoutRepoGitHubDomain().Create(workingDirectory));
+        PackageWithoutRepoUrl = new Lazy<IFileInfo>(() => new PackageWithoutRepoUrlOrCommit().Create(workingDirectory));
+        PackageWithoutRepoCommit = new Lazy<IFileInfo>(() => new PackageWithoutRepoUrlOrCommit().Create(workingDirectory));
     }
 
     private IDirectoryInfo GetWorkingDirectory()
diff --git a/Tests/Verify.Nupkg.Tests/SimplePackageTests.BasicTest/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/SimplePackageTests.BasicTest/manifest.verified.nuspec
@@ -1,5 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
-<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
   <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,5 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
-<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
   <metadata>
     <id>SimplePackage</id>
     <version>********</version>
diff --git a/Tests/Verify.Nupkg.Tests/SimplePackageTests.DoNotScrubVersionTest/contents.verified.txt b/Tests/Verify.Nupkg.Tests/SimplePackageTests.DoNotScrubVersionTest/contents.verified.txt
@@ -0,0 +1,6 @@
+﻿/
+|-- README.md
+|-- SimplePackage.nuspec
+|-- lib
+    |-- net8.0
+        |-- SimplePackage.dll
diff --git a/Tests/Verify.Nupkg.Tests/SimplePackageTests.DoNotScrubVersionTest/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/SimplePackageTests.DoNotScrubVersionTest/manifest.verified.nuspec
@@ -0,0 +1,13 @@
+﻿<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+  <metadata>
+    <id>SimplePackage</id>
+    <version>1.0.0</version>
+    <authors>SimplePackage</authors>
+    <readme>README.md</readme>
+    <description>Package Description</description>
+    <repository type="git" url="https://github.com/MattKotsenas/Verify.Nupkg.git" commit="****************************************" />
+    <dependencies>
+      <group targetFramework="net8.0" />
+    </dependencies>
+  </metadata>
+</package>
diff --git a/Tests/Verify.Nupkg.Tests/SimplePackageTests.cs b/Tests/Verify.Nupkg.Tests/SimplePackageTests.cs
@@ -27,4 +27,19 @@ public Task CustomFileExclusionTest()
 
         return VerifyFile(_simplePackage, settings);
     }
+
+    [Fact]
+    public Task DoNotScrubVersionTest()
+    {
+        // In this test we intentionally _do not_ include the version scrubber
+        // to validate that only scrubbers we opt-in to are applied.
+
+        VerifySettings settings = new();
+        settings.UseUniqueDirectory();
+
+        settings.ScrubNuspecCommit();
+        settings.ScrubNuspecRepositoryUrl();
+
+        return VerifyFile(_simplePackage, settings);
+    }
 }
diff --git a/Tests/Verify.Nupkg.Tests/VerifyNupkgPackageTests.Baseline/manifest.verified.nuspec b/Tests/Verify.Nupkg.Tests/VerifyNupkgPackageTests.Baseline/manifest.verified.nuspec
@@ -1,5 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
-<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
+﻿<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
   <metadata>
     <id>Verify.Nupkg</id>
     <version>********</version>
diff --git a/Verify.Nupkg/CommitScrubber.cs b/Verify.Nupkg/CommitScrubber.cs
@@ -0,0 +1,26 @@
+﻿using System.Xml.Linq;
+
+namespace VerifyTests;
+
+internal class CommitScrubber : NuspecScrubberBase
+{
+    protected override void Scrub(XDocument document)
+    {
+        XElement[] repositoryElements = document.DescendantsAnyNS("repository").ToArray();
+
+        foreach (XElement repositoryElement in repositoryElements)
+        {
+            XAttribute? commitAttribute = repositoryElement.Attribute("commit");
+
+            if (commitAttribute is null)
+            {
+                return;
+            }
+
+            // Length chosen because it's the standard length of a git SHA. Any number will work, but it should be consistent.
+            string replacement = new('*', count: 40);
+
+            commitAttribute.SetValue(replacement);
+        }
+    }
+}
diff --git a/Verify.Nupkg/NupkgDiffSettings.cs b/Verify.Nupkg/NupkgDiffSettings.cs
@@ -7,7 +7,7 @@ namespace VerifyTests;
 /// </summary>
 public class NupkgDiffSettings
 {
-    internal static readonly string ContextKey = "NupkgDiffSettings";
+    internal static string ContextKey { get; } = "NupkgDiffSettings";
 
     /// <summary>
     /// Gets the default regular expressions to use to exclude files from the diff.
diff --git a/Verify.Nupkg/NuspecScrubber.cs b/Verify.Nupkg/NuspecScrubber.cs
diff --git a/Verify.Nupkg/NuspecScrubberBase.cs b/Verify.Nupkg/NuspecScrubberBase.cs
@@ -0,0 +1,32 @@
+﻿using System.Text;
+using System.Xml;
+using System.Xml.Linq;
+
+namespace VerifyTests;
+
+internal abstract class NuspecScrubberBase
+{
+    public void Scrub(StringBuilder builder)
+    {
+        string text = builder.ToString();
+
+        if (XmlExtensions.TryParseForScrubbing(text, out XDocument? document))
+        {
+            Scrub(document);
+
+            builder.Clear();
+
+            using (XmlWriter writer = XmlWriter.Create(builder, new XmlWriterSettings
+            {
+                OmitXmlDeclaration = true,
+            }))
+            {
+                document.Save(writer);
+            }
+
+            builder.TrimStart();
+        }
+    }
+
+    protected abstract void Scrub(XDocument document);
+}
diff --git a/Verify.Nupkg/RepositoryUrlScrubber.cs b/Verify.Nupkg/RepositoryUrlScrubber.cs
@@ -0,0 +1,35 @@
+﻿using System.Xml.Linq;
+
+namespace VerifyTests;
+
+internal class RepositoryUrlScrubber : NuspecScrubberBase
+{
+    protected override void Scrub(XDocument document)
+    {
+        XElement[] repositoryElements = document.DescendantsAnyNS("repository").ToArray();
+
+        foreach (XElement repositoryElement in repositoryElements)
+        {
+            XAttribute? urlAttribute = repositoryElement.Attribute("url");
+
+            if (urlAttribute is null)
+            {
+                return;
+            }
+
+            UriBuilder url = new(urlAttribute.Value);
+
+            // Exclude non-GitHub URLs, and other formats like SSH
+            if (!(url.Host == "github.com" && url.Scheme == "https"))
+            {
+                return;
+            }
+
+            if (!url.Path.EndsWith(".git"))
+            {
+                url.Path += ".git";
+                urlAttribute.SetValue(url.Uri.ToString());
+            }
+        }
+    }
+}
diff --git a/Verify.Nupkg/StringBuilderExtensions.cs b/Verify.Nupkg/StringBuilderExtensions.cs
diff --git a/Verify.Nupkg/StringExtensions.cs b/Verify.Nupkg/StringExtensions.cs
diff --git a/Verify.Nupkg/VerifySettingsNupkgDiffSettingsExtensions.cs b/Verify.Nupkg/VerifySettingsNupkgDiffSettingsExtensions.cs
diff --git a/Verify.Nupkg/VerifySettingsScrubExtensions.cs b/Verify.Nupkg/VerifySettingsScrubExtensions.cs
diff --git a/Verify.Nupkg/VersionScrubber.cs b/Verify.Nupkg/VersionScrubber.cs
diff --git a/Verify.Nupkg/XElementExtensions.cs b/Verify.Nupkg/XElementExtensions.cs
diff --git a/Verify.Nupkg/XmlExtensions.cs b/Verify.Nupkg/XmlExtensions.cs
