mark SettingsTask returns as pure

VerifyTests · Sep 18, 2023 · 355a7fc · 355a7fc
1 parent 0adc5a3
commit 355a7fc
Show file tree

Hide file tree

Showing 58 changed files with 250 additions and 1 deletion.
diff --git a/src/Verify.MSTest/GlobalUsings.cs b/src/Verify.MSTest/GlobalUsings.cs
@@ -0,0 +1,3 @@
+// Global using directives
+
+global using System.Diagnostics.Contracts;
diff --git a/src/Verify.MSTest/VerifyBase.cs b/src/Verify.MSTest/VerifyBase.cs
@@ -60,19 +60,22 @@ static MethodInfo FindMethod(Type type, ReadOnlySpan<char> testName)
         throw new($"Could not find method `{type.Name}.{testName.ToString()}`.");
     }
 
+    [Pure]
     public SettingsTask Verify(
         object? target,
         IEnumerable<Target> rawTargets,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.Verify(target, rawTargets));
 
+    [Pure]
     public SettingsTask Verify(
         IEnumerable<Target> targets,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.Verify(targets));
 
+    [Pure]
     public SettingsTask Verify(
         Target target,
         VerifySettings? settings = null,

diff --git a/src/Verify.MSTest/VerifyBase_Archive.cs b/src/Verify.MSTest/VerifyBase_Archive.cs
@@ -7,6 +7,7 @@ public partial class VerifyBase
     /// <summary>
     /// Verifies the contents of a <see cref="ZipArchive"/>
     /// </summary>
+    [Pure]
     public SettingsTask Verify(
         ZipArchive archive,
         Func<ZipArchiveEntry, bool>? include = null,
@@ -19,6 +20,7 @@ public SettingsTask Verify(
     /// <summary>
     /// Verifies the contents of a <see cref="ZipArchive"/>
     /// </summary>
+    [Pure]
     public SettingsTask VerifyZip(
         string path,
         Func<ZipArchiveEntry, bool>? include = null,
@@ -31,6 +33,7 @@ public SettingsTask VerifyZip(
     /// <summary>
     /// Verifies the contents of a <see cref="ZipArchive"/>
     /// </summary>
+    [Pure]
     public SettingsTask VerifyZip(
         Stream stream,
         Func<ZipArchiveEntry, bool>? include = null,

diff --git a/src/Verify.MSTest/VerifyBase_Directory.cs b/src/Verify.MSTest/VerifyBase_Directory.cs
@@ -7,6 +7,7 @@ public partial class VerifyBase
     /// <summary>
     /// Verifies the contents of <paramref name="path"/>.
     /// </summary>
+    [Pure]
     public SettingsTask VerifyDirectory(
         string path,
         Func<string, bool>? include = null,
@@ -22,6 +23,7 @@ public SettingsTask VerifyDirectory(
     /// Verifies the contents of <paramref name="path"/>.
     /// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
     /// </summary>
+    [Pure]
     public SettingsTask VerifyDirectory(
         DirectoryInfo path,
         Func<string, bool>? include = null,
@@ -37,6 +39,7 @@ public SettingsTask VerifyDirectory(
     /// <summary>
     /// Verifies the contents of <paramref name="path"/>.
     /// </summary>
+    [Pure]
     public SettingsTask VerifyDirectory(
         string path,
         Func<string, bool>? include = null,
@@ -52,6 +55,7 @@ public SettingsTask VerifyDirectory(
     /// Verifies the contents of <paramref name="path"/>.
     /// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
     /// </summary>
+    [Pure]
     public SettingsTask VerifyDirectory(
         DirectoryInfo path,
         Func<string, bool>? include = null,

diff --git a/src/Verify.MSTest/VerifyBase_File.cs b/src/Verify.MSTest/VerifyBase_File.cs
@@ -5,6 +5,7 @@ public partial class VerifyBase
     /// <summary>
     /// Verifies the contents of <paramref name="path"/>.
     /// </summary>
+    [Pure]
     public SettingsTask VerifyFile(
         string path,
         VerifySettings? settings = null,
@@ -16,6 +17,7 @@ public SettingsTask VerifyFile(
     /// 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.
     /// </summary>
+    [Pure]
     public SettingsTask VerifyFile(
         FileInfo path,
         VerifySettings? settings = null,

diff --git a/src/Verify.MSTest/VerifyBase_Json.cs b/src/Verify.MSTest/VerifyBase_Json.cs
@@ -2,36 +2,42 @@
 
 public partial class VerifyBase
 {
+    [Pure]
     public SettingsTask VerifyJson(
         string? target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyJson(target));
 
+    [Pure]
     public SettingsTask VerifyJson(
         Task<string> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyJson(target));
 
+    [Pure]
     public SettingsTask VerifyJson(
         ValueTask<string> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyJson(target));
 
+    [Pure]
     public SettingsTask VerifyJson(
         Stream? target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyJson(target));
 
+    [Pure]
     public SettingsTask VerifyJson(
         Task<Stream> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyJson(target));
 
+    [Pure]
     public SettingsTask VerifyJson(
         ValueTask<Stream> target,
         VerifySettings? settings = null,

diff --git a/src/Verify.MSTest/VerifyBase_Object.cs b/src/Verify.MSTest/VerifyBase_Object.cs
@@ -2,24 +2,28 @@
 
 public partial class VerifyBase
 {
+    [Pure]
     public SettingsTask Verify<T>(
         Task<T> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "")=>
         Verify(settings, sourceFile, _ => _.Verify(target));
 
+    [Pure]
     public SettingsTask Verify<T>(
         ValueTask<T> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.Verify(target));
 
+    [Pure]
     public SettingsTask Verify<T>(
         IAsyncEnumerable<T> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "")=>
         Verify(settings, sourceFile, _ => _.Verify(target));
 
+    [Pure]
     public SettingsTask Verify(
         object? target,
         VerifySettings? settings = null,

diff --git a/src/Verify.MSTest/VerifyBase_Stream.cs b/src/Verify.MSTest/VerifyBase_Stream.cs
@@ -2,6 +2,7 @@
 
 public partial class VerifyBase
 {
+    [Pure]
     public SettingsTask Verify(
         byte[]? target,
         string extension,
@@ -10,13 +11,15 @@ public SettingsTask Verify(
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyStream(target, extension, info));
 
+    [Pure]
     public SettingsTask Verify(
         byte[]? target,
         VerifySettings? settings = null,
         object? info = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyStream(target, info));
 
+    [Pure]
     public SettingsTask Verify(
         Task<byte[]> target,
         string extension,
@@ -25,6 +28,7 @@ public SettingsTask Verify(
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyStream(target, extension, info));
 
+    [Pure]
     public SettingsTask Verify(
         ValueTask<byte[]> target,
         string extension,
@@ -33,13 +37,15 @@ public SettingsTask Verify(
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyStream(target, extension, info));
 
+    [Pure]
     public SettingsTask Verify(
         FileStream? target,
         VerifySettings? settings = null,
         object? info = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyStream(target, info));
 
+    [Pure]
     public SettingsTask Verify(
         Stream? target,
         string extension,
@@ -48,13 +54,15 @@ public SettingsTask Verify(
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyStream(target, extension, info));
 
+    [Pure]
     public SettingsTask Verify(
         Stream? target,
         VerifySettings? settings = null,
         object? info = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyStream(target, info));
 
+    [Pure]
     public SettingsTask Verify<T>(
         Task<T> target,
         string extension,
@@ -64,6 +72,7 @@ public SettingsTask Verify<T>(
         where T : Stream =>
         Verify(settings, sourceFile, _ => _.VerifyStream(target, extension, info));
 
+    [Pure]
     public SettingsTask Verify<T>(
         ValueTask<T> target,
         string extension,
@@ -73,6 +82,7 @@ public SettingsTask Verify<T>(
         where T : Stream =>
         Verify(settings, sourceFile, _ => _.VerifyStream(target, extension, info));
 
+    [Pure]
     public SettingsTask Verify<T>(
         IEnumerable<T> targets,
         string extension,

diff --git a/src/Verify.MSTest/VerifyBase_String.cs b/src/Verify.MSTest/VerifyBase_String.cs
@@ -2,25 +2,29 @@
 
 public partial class VerifyBase
 {
+    [Pure]
     public SettingsTask Verify(
         string? target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyString(target));
 
+    [Pure]
     public SettingsTask Verify(
         Task<string> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyString(target));
 
+    [Pure]
     public SettingsTask Verify(
         string? target,
         string extension,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyString(target, extension));
 
+    [Pure]
     public SettingsTask Verify(
         Task<string> target,
         string extension,

diff --git a/src/Verify.MSTest/VerifyBase_Throws.cs b/src/Verify.MSTest/VerifyBase_Throws.cs
@@ -2,36 +2,42 @@
 
 public partial class VerifyBase
 {
+    [Pure]
     public SettingsTask Throws(
         Action target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.Throws(target));
 
+    [Pure]
     public SettingsTask Throws(
         Func<object?> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.Throws(target));
 
+    [Pure]
     public SettingsTask ThrowsTask(
         Func<Task> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.ThrowsTask(target));
 
+    [Pure]
     public SettingsTask ThrowsTask<T>(
         Func<Task<T>> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.ThrowsTask(target));
 
+    [Pure]
     public SettingsTask ThrowsValueTask(
         Func<ValueTask> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.ThrowsValueTask(target));
 
+    [Pure]
     public SettingsTask ThrowsValueTask<T>(
         Func<ValueTask<T>> target,
         VerifySettings? settings = null,

diff --git a/src/Verify.MSTest/VerifyBase_Tuple.cs b/src/Verify.MSTest/VerifyBase_Tuple.cs
@@ -3,6 +3,7 @@ namespace VerifyMSTest
 {
     public partial class VerifyBase
     {
+        [Pure]
         public SettingsTask VerifyTuple(
             Expression<Func<ITuple>> target,
             VerifySettings? settings = null,

diff --git a/src/Verify.MSTest/VerifyBase_Xml.cs b/src/Verify.MSTest/VerifyBase_Xml.cs
@@ -2,36 +2,42 @@
 
 public partial class VerifyBase
 {
+    [Pure]
     public SettingsTask VerifyXml(
         string? target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyXml(target));
 
+    [Pure]
     public SettingsTask VerifyXml(
         Task<string> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyXml(target));
 
+    [Pure]
     public SettingsTask VerifyXml(
         ValueTask<string> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyXml(target));
 
+    [Pure]
     public SettingsTask VerifyXml(
         Stream? target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyXml(target));
 
+    [Pure]
     public SettingsTask VerifyXml(
         Task<Stream> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.VerifyXml(target));
 
+    [Pure]
     public SettingsTask VerifyXml(
         ValueTask<Stream> target,
         VerifySettings? settings = null,

diff --git a/src/Verify.NUnit/GlobalUsings.cs b/src/Verify.NUnit/GlobalUsings.cs
@@ -0,0 +1,3 @@
+// Global using directives
+
+global using System.Diagnostics.Contracts;