Add AppendFile (#748)

docs/append-file.md

@@ -0,0 +1,38 @@
+<!--
+GENERATED FILE - DO NOT EDIT
+This file was generated by [MarkdownSnippets](https://github.com/SimonCropp/MarkdownSnippets).
+Source File: /docs/mdsource/append-file.source.md
+To change this file edit the source file and then run MarkdownSnippets.
+-->
+
+# AppendFile
+
+Allows extra files to be verified in addition to the primary target.
+
+
+## Binary
+
+<!-- snippet: BinaryFluent -->
+<a id='snippet-binaryfluent'></a>
+```cs
+[Fact]
+public Task BinaryFluent() =>
+    Verify("Foo", settings)
+        .AppendFile("sample.png");
+```
+<sup><a href='/src/Verify.Tests/Converters/InstanceFileAppenderTests.cs#L21-L28' title='Snippet source file'>snippet source</a> | <a href='#snippet-binaryfluent' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+
+## Text
+
+<!-- snippet: TextFluent -->
+<a id='snippet-textfluent'></a>
+```cs
+[Fact]
+public Task TextFluent() =>
+    Verify("Foo")
+        .AppendFile("extra content");
+```
+<sup><a href='/src/Verify.Tests/Converters/InstanceFileAppenderTests.cs#L30-L37' title='Snippet source file'>snippet source</a> | <a href='#snippet-textfluent' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->

docs/mdsource/append-file.source.md

@@ -0,0 +1,13 @@
+# AppendFile
+
+Allows extra files to be verified in addition to the primary target.
+
+
+## Binary
+
+snippet: BinaryFluent
+
+
+## Text
+
+snippet: TextFluent

docs/mdsource/doc-index.include.md

@@ -6,6 +6,7 @@
   * [VerifyXml](/docs/verify-xml.md)
   * [Serializer Settings](/docs/serializer-settings.md)
   * [File naming](/docs/naming.md)
+  * [AppendFile](/docs/append-file.md)
   * [Parameterised tests](/docs/parameterised.md)
   * [Named Tuples](/docs/named-tuples.md)
   * [Scrubbers](/docs/scrubbers.md)

docs/naming.md

@@ -582,7 +582,7 @@ public static string NameWithParent(this Type type)
     return type.Name;
 }
 ```
-<sup><a href='/src/Verify/Extensions.cs#L49-L61' title='Snippet source file'>snippet source</a> | <a href='#snippet-defaultderivepathinfo-4' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify/Extensions.cs#L52-L64' title='Snippet source file'>snippet source</a> | <a href='#snippet-defaultderivepathinfo-4' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 

docs/readme.md

@@ -15,6 +15,7 @@ To change this file edit the source file and then run MarkdownSnippets.
   * [VerifyXml](/docs/verify-xml.md)
   * [Serializer Settings](/docs/serializer-settings.md)
   * [File naming](/docs/naming.md)
+  * [AppendFile](/docs/append-file.md)
   * [Parameterised tests](/docs/parameterised.md)
   * [Named Tuples](/docs/named-tuples.md)
   * [Scrubbers](/docs/scrubbers.md)

readme.md

@@ -568,6 +568,7 @@ Nick Chapsas (1 August 2022)](https://www.youtube.com/watch?v=Q1_YkcPwpqY)
   * [VerifyXml](/docs/verify-xml.md)
   * [Serializer Settings](/docs/serializer-settings.md)
   * [File naming](/docs/naming.md)
+  * [AppendFile](/docs/append-file.md)
   * [Parameterised tests](/docs/parameterised.md)
   * [Named Tuples](/docs/named-tuples.md)
   * [Scrubbers](/docs/scrubbers.md)

src/Verify.Tests/Converters/InstanceFileAppenderTests.BinaryFluent#01.verified.txt

@@ -0,0 +1 @@
+appendedFile

src/Verify.Tests/Converters/InstanceFileAppenderTests.BinaryFluent#02.verified.txt

@@ -0,0 +1 @@
+sample.png

src/Verify.Tests/Converters/InstanceFileAppenderTests.Text#01.verified.txt

@@ -0,0 +1 @@
+appendedFile

src/Verify.Tests/Converters/InstanceFileAppenderTests.TextBytesFluent#01.verified.txt

@@ -0,0 +1 @@
+appendedFile

src/Verify.Tests/Converters/InstanceFileAppenderTests.TextFluent#00.verified.txt

@@ -0,0 +1 @@
+Foo

src/Verify.Tests/Converters/InstanceFileAppenderTests.TextFluent#01.verified.txt

@@ -0,0 +1 @@
+extra content

src/Verify.Tests/Converters/InstanceFileAppenderTests.TextStreamFluent#00.verified.txt

@@ -0,0 +1 @@
+Foo

src/Verify.Tests/Converters/InstanceFileAppenderTests.TextStreamFluent#01.verified.txt

@@ -0,0 +1 @@
+appendedFile

src/Verify.Tests/Converters/InstanceFileAppenderTests.WithName#00.verified.txt

@@ -0,0 +1 @@
+Foo

src/Verify.Tests/Converters/InstanceFileAppenderTests.WithName#01.verified.txt

@@ -0,0 +1 @@
+appendedFile

src/Verify.Tests/Converters/InstanceFileAppenderTests.WithName#theName.verified.txt

@@ -0,0 +1 @@
+extra content

src/Verify.Tests/Converters/InstanceFileAppenderTests.WithScrubbing#00.verified.txt

@@ -0,0 +1 @@
+Foo

src/Verify.Tests/Converters/InstanceFileAppenderTests.WithScrubbing#01.verified.txt

@@ -0,0 +1,2 @@
+line1
+line3

src/Verify.Tests/Converters/InstanceFileAppenderTests.cs

@@ -0,0 +1,58 @@
+[UsesVerify]
+public class InstanceFileAppenderTests
+{
+    VerifySettings settings;
+
+    public InstanceFileAppenderTests()
+    {
+        settings = new();
+        settings.AppendFile("appendedFile");
+    }
+
+    [Fact]
+    public Task Text() =>
+        Verify("Foo", settings);
+
+    [Fact]
+    public Task WithName() =>
+        Verify("Foo", settings)
+            .AppendFile("extra content", name: "theName");
+
+    #region BinaryFluent
+
+    [Fact]
+    public Task BinaryFluent() =>
+        Verify("Foo", settings)
+            .AppendFile("sample.png");
+
+    #endregion
+
+    #region TextFluent
+
+    [Fact]
+    public Task TextFluent() =>
+        Verify("Foo")
+            .AppendFile("extra content");
+
+    #endregion
+
+    [Fact]
+    public Task WithScrubbing() =>
+        Verify("Foo")
+            .AppendFile("""
+                line1
+                line2
+                line3
+                """)
+            .ScrubLinesContaining("line2");
+
+    [Fact]
+    public Task TextBytesFluent() =>
+        Verify("Foo")
+            .AppendFile(Encoding.UTF8.GetBytes("appendedFile"));
+
+    [Fact]
+    public Task TextStreamFluent() =>
+        Verify("Foo")
+            .AppendFile(new MemoryStream(Encoding.UTF8.GetBytes("appendedFile")));
+}

src/Verify.Tests/Converters/StaticFileAppenderTests.File#00.verified.txt

@@ -0,0 +1 @@
+Foo

src/Verify.Tests/Converters/StaticFileAppenderTests.Stream#00.verified.txt

@@ -0,0 +1 @@
+Foo

src/Verify.Tests/Converters/StaticFileAppenderTests.Text#00.verified.txt

@@ -0,0 +1 @@
+Foo

src/Verify.Tests/Converters/FileAppenderTests.cs → src/Verify.Tests/Converters/StaticFileAppenderTests.cs

@@ -1,5 +1,5 @@
 [UsesVerify]
-public class FileAppenderTests :
+public class StaticFileAppenderTests :
     IDisposable
 {
     static AsyncLocal<bool> isInThisTest = new();
@@ -17,7 +17,7 @@ public static void Initialize() =>
                 return new("txt", "data");
             });
 
-    public FileAppenderTests() =>
+    public StaticFileAppenderTests() =>
         isInThisTest.Value = true;
 
     public void Dispose() =>

src/Verify.Tests/Converters/FileAppenderWithScrubberTests.cs → src/Verify.Tests/Converters/StaticFileAppenderWithScrubberTests.cs

@@ -1,5 +1,5 @@
 [UsesVerify]
-public class FileAppenderWithScrubberTests :
+public class StaticFileAppenderWithScrubberTests :
     IDisposable
 {
     static AsyncLocal<bool> isInThisTest = new();
@@ -29,7 +29,7 @@ public static void Initialize()
             });
     }
 
-    public FileAppenderWithScrubberTests() =>
+    public StaticFileAppenderWithScrubberTests() =>
         isInThisTest.Value = true;
 
     public void Dispose() =>

src/Verify/Extensions.cs

@@ -1,5 +1,8 @@
 static class Extensions
 {
+    public static string Extension(this FileStream file) =>
+        FileExtensions.GetExtension(file.Name);
+
     public static async Task<List<T>> ToList<T>(this IAsyncEnumerable<T> target)
     {
         var list = new List<T>();

src/Verify/Splitters/Settings_FileAppender.cs

@@ -14,11 +14,89 @@ internal static IEnumerable<Target> GetFileAppenders(VerifySettings settings)
                 yield return target.Value;
             }
         }
+
+        foreach (var target in settings.appendedFiles)
+        {
+            yield return target;
+        }
     }
 
     public static void RegisterFileAppender(FileAppender appender)
     {
         InnerVerifier.ThrowIfVerifyHasBeenRun();
         fileAppenders.Add(appender);
     }
+}
+
+public partial class VerifySettings
+{
+    internal List<Target> appendedFiles = new();
+
+    public void AppendFile(string content, string extension = "txt", string? name = null) =>
+        appendedFiles.Add(new(extension, content, name));
+
+    public void AppendFile(StringBuilder content, string extension = "txt", string? name = null) =>
+        appendedFiles.Add(new(extension, content, name));
+
+    public void AppendFile(byte[] content, string extension = "txt", string? name = null)
+    {
+        if (FileExtensions.IsText(extension))
+        {
+            appendedFiles.Add(new(extension, Encoding.UTF8.GetString(content), name));
+        }
+        else
+        {
+            appendedFiles.Add(new(extension, new MemoryStream(content), name));
+        }
+    }
+
+    public void AppendFile(FileStream stream, string? name = null) =>
+        AppendFile(stream, stream.Extension(), name??Path.GetFileNameWithoutExtension(stream.Name));
+
+    public void AppendFile(Stream stream, string extension = "txt", string? name = null)
+    {
+        stream.MoveToStart();
+        if (FileExtensions.IsText(extension))
+        {
+            using var reader = new StreamReader(stream, Encoding.UTF8);
+            appendedFiles.Add(new(extension, reader.ReadToEnd(), name));
+        }
+        else
+        {
+            appendedFiles.Add(new(extension, stream, name));
+        }
+    }
+}
+
+public partial class SettingsTask
+{
+    public SettingsTask AppendFile(StringBuilder content, string extension = "txt", string? name = null)
+    {
+        CurrentSettings.AppendFile(content, extension, name);
+        return this;
+    }
+
+    public SettingsTask AppendFile(string content, string extension = "txt", string? name = null)
+    {
+        CurrentSettings.AppendFile(content, extension, name);
+        return this;
+    }
+
+    public SettingsTask AppendFile(byte[] content, string extension = "txt", string? name = null)
+    {
+        CurrentSettings.AppendFile(content, extension, name);
+        return this;
+    }
+
+    public SettingsTask AppendFile(FileStream stream, string? name = null)
+    {
+        CurrentSettings.AppendFile(stream, name);
+        return this;
+    }
+
+    public SettingsTask AppendFile(Stream stream, string extension = "txt", string? name = null)
+    {
+        CurrentSettings.AppendFile(stream, extension, name);
+        return this;
+    }
 }

src/Verify/Verifier/InnerVerifier_Stream.cs

@@ -14,7 +14,7 @@ public Task<VerifyResult> VerifyStream(FileStream? stream, object? info)
             return Verify(info);
         }
 
-        return VerifyStream(stream, FileExtensions.GetExtension(stream.Name), info);
+        return VerifyStream(stream, stream.Extension(), info);
     }
 
     public Task<VerifyResult> VerifyStream(byte[]? bytes, object? info) =>

src/Verify/VerifySettings.cs

@@ -16,6 +16,7 @@ public VerifySettings(VerifySettings? settings)
 #endif
         methodName = settings.methodName;
         typeName = settings.typeName;
+        appendedFiles = settings.appendedFiles;
         useUniqueDirectory = settings.useUniqueDirectory;
         Directory = settings.Directory;
         autoVerify = settings.autoVerify;