Add VerifyFiles (#1465)

* Update Verifier_File.cs

* .

* .

* .

* Update Directory.Build.props

* .

* Update Verifier_File.cs

* .

Author: SimonCropp

docs/mdsource/verify-file.source.md

@@ -2,7 +2,7 @@
 <Project>
   <PropertyGroup>
     <NoWarn>CA1822;CS1591;CS0649;xUnit1026;xUnit1013;CS1573;VerifyTestsProjectDir;VerifySetParameters;PolyFillTargetsForNuget;xUnit1051;NU1608;NU1109</NoWarn>
-    <Version>30.2.0</Version>
+    <Version>30.3.0</Version>
     <ImplicitUsings>enable</ImplicitUsings>
     <LangVersion>preview</LangVersion>
     <AssemblyVersion>1.0.0</AssemblyVersion>

docs/verify-file.md

@@ -0,0 +1 @@
+Content 1

src/Directory.Build.props

@@ -0,0 +1 @@
+Content 2

src/Verify.Expecto.Tests/File1.txt

@@ -11,6 +11,14 @@
     <PackageReference Include="ProjectDefaults" PrivateAssets="all" />
     <ProjectReference Include="..\Verify.Expecto\Verify.Expecto.csproj" />
   </ItemGroup>
+  <ItemGroup>
+    <None Update="File2.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="File1.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
   <Import Project="$(ProjectDir)..\Verify\buildTransitive\Verify.props" />
   <Import Project="$(ProjectDir)..\Verify\buildTransitive\Verify.targets" />
   <Import Project="$(ProjectDir)..\Verify.Expecto\buildTransitive\Verify.Expecto.props" />

src/Verify.Expecto.Tests/File2.txt

@@ -20,6 +20,22 @@ public static SettingsTask VerifyFile(
         return Verify(settings, assembly, sourceFile, name, _ => _.VerifyFile(path, info, extension));
     }
 
+    /// <summary>
+    /// Verifies the contents of files.
+    /// </summary>
+    [Pure]
+    public static SettingsTask VerifyFiles(
+        string name,
+        IEnumerable<string> paths,
+        VerifySettings? settings = null,
+        object? info = null,
+        FileScrubber? fileScrubber = null,
+        [CallerFilePath] string sourceFile = "")
+    {
+        var assembly = Assembly.GetCallingAssembly()!;
+        return Verify(settings, assembly, sourceFile, name, _ => _.VerifyFiles(paths, info, fileScrubber));
+    }
+
     /// <summary>
     /// Verifies the contents of <paramref name="path" />.
     /// Differs from passing <see cref="FileInfo" /> to <code>Verify(object? target)</code> which will verify the full path.

src/Verify.Expecto.Tests/Verify.Expecto.Tests.csproj

@@ -0,0 +1 @@
+Content 1

src/Verify.Expecto/Verifier_File.cs

@@ -0,0 +1 @@
+Content 2

src/Verify.Fixie.Tests/File1.txt

@@ -13,6 +13,14 @@
     <ProjectReference Include="..\Verify.Fixie\Verify.Fixie.csproj" />
     <ProjectReference Include="..\Verify\Verify.csproj" />
   </ItemGroup>
+  <ItemGroup>
+    <None Update="File1.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="File2.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
   <Import Project="$(ProjectDir)..\Verify\buildTransitive\Verify.props" />
   <Import Project="$(ProjectDir)..\Verify\buildTransitive\Verify.targets" />
   <Import Project="$(ProjectDir)..\Verify.Fixie\buildTransitive\Verify.Fixie.props" />

src/Verify.Fixie.Tests/File2.txt

@@ -0,0 +1 @@
+Content 1

src/Verify.Fixie.Tests/Verify.Fixie.Tests.csproj

@@ -0,0 +1 @@
+Content 2

src/Verify.Fixie.Tests/VerifyFilesTests.Run#File1.verified.txt

@@ -0,0 +1 @@
+New

src/Verify.Fixie.Tests/VerifyFilesTests.Run#File2.verified.txt

@@ -0,0 +1 @@
+New

src/Verify.Fixie.Tests/VerifyFilesTests.WithFileScrubber#File1.verified.txt

@@ -0,0 +1 @@
+Content 1

src/Verify.Fixie.Tests/VerifyFilesTests.WithFileScrubber#File2.verified.txt

@@ -0,0 +1 @@
+Content 2

src/Verify.Fixie.Tests/VerifyFilesTests.WithInfo#File1.verified.txt

@@ -0,0 +1,3 @@
+{
+  Key: Value
+}

src/Verify.Fixie.Tests/VerifyFilesTests.WithInfo#File2.verified.txt

@@ -0,0 +1,22 @@
+public class VerifyFilesTests
+{
+    public Task Run() =>
+        VerifyFiles(["File1.txt", "File2.txt"]);
+
+    public Task WithInfo() =>
+        VerifyFiles(
+            ["File1.txt", "File2.txt"],
+            info: new
+            {
+                Key = "Value"
+            });
+
+    public Task WithFileScrubber() =>
+        VerifyFiles(
+            ["File1.txt", "File2.txt"],
+            fileScrubber: (_, builder) =>
+            {
+                builder.Clear();
+                builder.Append("New");
+            });
+}

src/Verify.Fixie.Tests/VerifyFilesTests.WithInfo.verified.txt

@@ -14,6 +14,18 @@ public static SettingsTask VerifyFile(
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyFile(path, info, extension));
 
+    /// <summary>
+    /// Verifies the contents of files.
+    /// </summary>
+    [Pure]
+    public static SettingsTask VerifyFiles(
+        IEnumerable<string> paths,
+        VerifySettings? settings = null,
+        object? info = null,
+        FileScrubber? fileScrubber = null,
+        [CallerFilePath] string sourceFile = "") =>
+        Verify(settings, sourceFile, _ => _.VerifyFiles(paths, info, fileScrubber));
+
     /// <summary>
     /// Verifies the contents of <paramref name="path" />.
     /// Differs from passing <see cref="FileInfo" /> to <code>Verify(object? target)</code> which will verify the full path.

src/Verify.Fixie.Tests/VerifyFilesTests.cs

@@ -0,0 +1 @@
+Content 1

src/Verify.Fixie/Verifier_File.cs

@@ -0,0 +1 @@
+Content 2

src/Verify.MSTest.Tests/File1.txt

@@ -17,6 +17,12 @@
     <ProjectReference Include="..\Verify.MSTest\Verify.MSTest.csproj" />
     <ProjectReference Include="..\Verify\Verify.csproj" />
     <ProjectReference Include="..\Verify.MSTest.SourceGenerator\Verify.MSTest.SourceGenerator.csproj" ReferenceOutputAssembly="false" OutputItemType="Analyzer" />
+    <None Update="File2.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="File1.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFrameworkIdentifier)' == '.NETFramework'">

src/Verify.MSTest.Tests/File2.txt

@@ -0,0 +1 @@
+Content 1

src/Verify.MSTest.Tests/Verify.MSTest.Tests.csproj

@@ -0,0 +1 @@
+Content 2

src/Verify.MSTest.Tests/VerifyFilesTests.Run#File1.verified.txt

@@ -0,0 +1 @@
+New

src/Verify.MSTest.Tests/VerifyFilesTests.Run#File2.verified.txt

@@ -0,0 +1 @@
+New

src/Verify.MSTest.Tests/VerifyFilesTests.WithFileScrubber#File1.verified.txt

@@ -0,0 +1 @@
+Content 1

src/Verify.MSTest.Tests/VerifyFilesTests.WithFileScrubber#File2.verified.txt

@@ -0,0 +1 @@
+Content 2

src/Verify.MSTest.Tests/VerifyFilesTests.WithInfo#File1.verified.txt

@@ -0,0 +1,3 @@
+{
+  Key: Value
+}

src/Verify.MSTest.Tests/VerifyFilesTests.WithInfo#File2.verified.txt

@@ -0,0 +1,26 @@
+[TestClass]
+public partial class VerifyFilesTests
+{
+    [TestMethod]
+    public Task Run() =>
+        VerifyFiles(["File1.txt", "File2.txt"]);
+
+    [TestMethod]
+    public Task WithInfo() =>
+        VerifyFiles(
+            ["File1.txt", "File2.txt"],
+            info: new
+            {
+                Key = "Value"
+            });
+
+    [TestMethod]
+    public Task WithFileScrubber() =>
+        VerifyFiles(
+            ["File1.txt", "File2.txt"],
+            fileScrubber: (_, builder) =>
+            {
+                builder.Clear();
+                builder.Append("New");
+            });
+}

src/Verify.MSTest.Tests/VerifyFilesTests.WithInfo.verified.txt

@@ -14,6 +14,18 @@ public static SettingsTask VerifyFile(
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyFile(path, info, extension));
 
+    /// <summary>
+    /// Verifies the contents of files.
+    /// </summary>
+    [Pure]
+    public static SettingsTask VerifyFiles(
+        IEnumerable<string> paths,
+        VerifySettings? settings = null,
+        object? info = null,
+        FileScrubber? fileScrubber = null,
+        [CallerFilePath] string sourceFile = "") =>
+        Verify(settings, sourceFile, _ => _.VerifyFiles(paths, info, fileScrubber));
+
     /// <summary>
     /// Verifies the contents of <paramref name="path" />.
     /// Differs from passing <see cref="FileInfo" /> to <code>Verify(object? target)</code> which will verify the full path.

src/Verify.MSTest.Tests/VerifyFilesTests.cs

@@ -15,6 +15,18 @@ public SettingsTask VerifyFile(
         [CallerFilePath] string sourceFile = "") =>
         Verifier.VerifyFile(path, settings, info, null, sourceFile);
 
+    /// <summary>
+    /// Verifies the contents of files.
+    /// </summary>
+    [Pure]
+    public SettingsTask VerifyFiles(
+        IEnumerable<string> paths,
+        VerifySettings? settings = null,
+        object? info = null,
+        FileScrubber? fileScrubber = null,
+        [CallerFilePath] string sourceFile = "") =>
+        Verifier.VerifyFiles(paths, settings, info, fileScrubber, sourceFile);
+
     /// <summary>
     /// Verifies the contents of <paramref name="path" />.
     /// Differs from passing <see cref="FileInfo" /> to <code>Verify(object? target)</code> which will verify the full path.

src/Verify.MSTest/Verifier_File.cs

@@ -0,0 +1 @@
+Content 1

src/Verify.MSTest/VerifyBase_File.cs

@@ -0,0 +1 @@
+Content 2

src/Verify.NUnit.Tests/File1.txt

@@ -24,6 +24,15 @@
     <Reference Include="System.IO.Compression" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Update="File1.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="File2.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
+
   <Import Project="$(ProjectDir)..\Verify\buildTransitive\Verify.props" />
   <Import Project="$(ProjectDir)..\Verify\buildTransitive\Verify.targets" />
   <Import Project="$(ProjectDir)..\Verify.NUnit\buildTransitive\Verify.NUnit.props" />

src/Verify.NUnit.Tests/File2.txt

@@ -0,0 +1 @@
+Content 1

src/Verify.NUnit.Tests/Verify.NUnit.Tests.csproj

@@ -0,0 +1 @@
+Content 2

src/Verify.NUnit.Tests/VerifyFilesTests.Run#File1.verified.txt

@@ -0,0 +1 @@
+New

src/Verify.NUnit.Tests/VerifyFilesTests.Run#File2.verified.txt

@@ -0,0 +1 @@
+New

src/Verify.NUnit.Tests/VerifyFilesTests.WithFileScrubber#File1.verified.txt

@@ -0,0 +1 @@
+Content 1

src/Verify.NUnit.Tests/VerifyFilesTests.WithFileScrubber#File2.verified.txt

@@ -0,0 +1 @@
+Content 2

src/Verify.NUnit.Tests/VerifyFilesTests.WithInfo#File1.verified.txt

@@ -0,0 +1,3 @@
+{
+  Key: Value
+}