Make DerivePathInfo specific to test framework (VerifyTests#646)

Author: SimonCropp

docs/build-server.md

@@ -93,7 +93,7 @@ For example a possible implementation for [AppVeyor](https://www.appveyor.com/)
 if (BuildServerDetector.Detected)
 {
     var buildDirectory = Environment.GetEnvironmentVariable("APPVEYOR_BUILD_FOLDER")!;
-    VerifierSettings.DerivePathInfo(
+    Verifier.DerivePathInfo(
         (sourceFile, projectDirectory, typeName, methodName) =>
         {
             var testDirectory = Path.GetDirectoryName(sourceFile)!;

docs/naming.md

@@ -551,11 +551,11 @@ For example to place all `.verified.` files in a `{ProjectDirectory}\Snapshots`
 <!-- snippet: DerivePathInfo -->
 <a id='snippet-derivepathinfo'></a>
 ```cs
-VerifierSettings.DerivePathInfo(
-    (sourceFile, projectDirectory, typeName, methodName) => new(
+Verifier.DerivePathInfo(
+    (sourceFile, projectDirectory, type, method) => new(
         directory: Path.Combine(projectDirectory, "Snapshots"),
-        typeName: typeName,
-        methodName: methodName));
+        typeName: type.Name,
+        methodName: method.Name));
 ```
 <sup><a href='/src/Verify.Tests/Snippets/Snippets.cs#L63-L71' title='Snippet source file'>snippet source</a> | <a href='#snippet-derivepathinfo' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
@@ -578,9 +578,36 @@ static DerivePathInfo derivePathInfo = (sourceFile, projectDirectory, type, meth
         typeName: type,
         methodName: method);
 ```
-<sup><a href='/src/Verify/DerivePaths/VerifierSettings.cs#L7-L15' title='Snippet source file'>snippet source</a> | <a href='#snippet-defaultderivepathinfo' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Expecto/DerivePaths/VerifierSettings.cs#L7-L15' title='Snippet source file'>snippet source</a> | <a href='#snippet-defaultderivepathinfo' title='Start of snippet'>anchor</a></sup>
 <a id='snippet-defaultderivepathinfo-1'></a>
 ```cs
+static DerivePathInfo derivePathInfo = (sourceFile, projectDirectory, type, method) =>
+    new(
+        directory: Path.GetDirectoryName(sourceFile)!,
+        typeName: type.NameWithParent(),
+        methodName: method.Name);
+```
+<sup><a href='/src/Verify.MSTest/DerivePaths/VerifierSettings.cs#L7-L15' title='Snippet source file'>snippet source</a> | <a href='#snippet-defaultderivepathinfo-1' title='Start of snippet'>anchor</a></sup>
+<a id='snippet-defaultderivepathinfo-2'></a>
+```cs
+static DerivePathInfo derivePathInfo = (sourceFile, projectDirectory, type, method) =>
+    new(
+        directory: Path.GetDirectoryName(sourceFile)!,
+        typeName: type.NameWithParent(),
+        methodName: method.Name);
+```
+<sup><a href='/src/Verify.NUnit/DerivePaths/VerifierSettings.cs#L7-L15' title='Snippet source file'>snippet source</a> | <a href='#snippet-defaultderivepathinfo-2' title='Start of snippet'>anchor</a></sup>
+<a id='snippet-defaultderivepathinfo-3'></a>
+```cs
+static DerivePathInfo derivePathInfo = (sourceFile, projectDirectory, type, method) =>
+    new(
+        directory: Path.GetDirectoryName(sourceFile)!,
+        typeName: type.NameWithParent(),
+        methodName: method.Name);
+```
+<sup><a href='/src/Verify.Xunit/DerivePaths/VerifierSettings.cs#L7-L15' title='Snippet source file'>snippet source</a> | <a href='#snippet-defaultderivepathinfo-3' title='Start of snippet'>anchor</a></sup>
+<a id='snippet-defaultderivepathinfo-4'></a>
+```cs
 public static string NameWithParent(this Type type)
 {
     if (type.IsNested)
@@ -591,7 +618,7 @@ public static string NameWithParent(this Type type)
     return type.Name;
 }
 ```
-<sup><a href='/src/Verify/Extensions.cs#L27-L39' title='Snippet source file'>snippet source</a> | <a href='#snippet-defaultderivepathinfo-1' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify/Extensions.cs#L27-L39' title='Snippet source file'>snippet source</a> | <a href='#snippet-defaultderivepathinfo-4' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 

src/StrictJsonTests/ModuleInit.cs

@@ -8,8 +8,7 @@ public static void Init()
         VerifierSettings.UseStrictJson();
 
         #endregion
-        VerifierSettings.DerivePathInfo(
-            (_, _, typeName, methodName) => new(AttributeReader.GetProjectDirectory(), typeName: typeName, methodName));
+        DerivePathInfo(
+            (_, _, type, method) => new(AttributeReader.GetProjectDirectory(), typeName: type.Name, method.Name));
     }
-
 }

src/Verify.DerivePaths.Tests/Tests.cs

@@ -4,7 +4,7 @@ public class Tests
     [Fact]
     public Task Test()
     {
-        VerifierSettings.DerivePathInfo(
+        DerivePathInfo(
             (sourceFile, projectDirectory, methodName, typeName) =>
             {
                 Assert.True(File.Exists(sourceFile));
@@ -21,28 +21,28 @@ public Task Test()
     [Fact]
     public Task ReturnNulls()
     {
-        VerifierSettings.DerivePathInfo((_, _, _, _) => new(null));
+        DerivePathInfo((_, _, _, _) => new(null));
         return Verify("Value");
     }
 
     [Fact]
     public Task InvalidMethod()
     {
-        VerifierSettings.DerivePathInfo((_, _, _, _) => new(null, null, Path.GetInvalidFileNameChars().First().ToString()));
+        DerivePathInfo((_, _, _, _) => new(null, null, Path.GetInvalidFileNameChars().First().ToString()));
         return Assert.ThrowsAsync<ArgumentException>(() => Verify("Value"));
     }
 
     [Fact]
     public Task InvalidType()
     {
-        VerifierSettings.DerivePathInfo((_, _, _, _) => new(null, Path.GetInvalidFileNameChars().First().ToString()));
+        DerivePathInfo((_, _, _, _) => new(null, Path.GetInvalidFileNameChars().First().ToString()));
         return Assert.ThrowsAsync<ArgumentException>(() => Verify("Value"));
     }
 
     [Fact]
     public Task InvalidDirectory()
     {
-        VerifierSettings.DerivePathInfo((_, _, _, _) => new(Path.GetInvalidPathChars().First().ToString()));
+        DerivePathInfo((_, _, _, _) => new(Path.GetInvalidPathChars().First().ToString()));
         return Assert.ThrowsAsync<ArgumentException>(() => Verify("Value"));
     }
 }

src/Verify/DerivePaths/DerivePathInfo.cs renamed to src/Verify.Expecto/DerivePaths/DerivePathInfo.cs

@@ -1,4 +1,4 @@
-namespace VerifyTests;
+namespace VerifyExpecto;
 
 /// <summary>
 /// Signature for deriving a custom path information for `.verified.` files.

src/Verify/DerivePaths/VerifierSettings.cs renamed to src/Verify.Expecto/DerivePaths/VerifierSettings.cs

@@ -1,8 +1,8 @@
 // ReSharper disable UnusedParameter.Local
 
-namespace VerifyTests;
+namespace VerifyExpecto;
 
-public static partial class VerifierSettings
+public partial class Verifier
 {
     #region defaultDerivePathInfo
 
@@ -26,5 +26,5 @@ internal static PathInfo GetPathInfo(string sourceFile, string typeName, string
     /// </remarks>
     /// <param name="derivePathInfo">Custom callback to control the behavior.</param>
     public static void DerivePathInfo(DerivePathInfo derivePathInfo) =>
-        VerifierSettings.derivePathInfo = derivePathInfo;
+        Verifier.derivePathInfo = derivePathInfo;
 }

src/Verify.Expecto/Verifier.cs

@@ -16,7 +16,8 @@ static InnerVerifier GetVerifier(VerifySettings settings, string sourceFile, str
 
         var fileName = Path.GetFileNameWithoutExtension(sourceFile);
 
-        return new(sourceFile, settings, fileName, methodName, new());
+        var pathInfo = GetPathInfo(sourceFile, fileName, methodName);
+        return new(sourceFile, settings, fileName, methodName, new(), pathInfo);
     }
 
     [DoesNotReturn]

src/Verify.MSTest/DerivePaths/DerivePathInfo.cs

@@ -0,0 +1,10 @@
+namespace VerifyMSTest;
+
+/// <summary>
+/// Signature for deriving a custom path information for `.verified.` files.
+/// </summary>
+/// <param name="sourceFile">The source file derived from <see cref="CallerFilePathAttribute" />.</param>
+/// <param name="projectDirectory">The directory of the project that the test was compile from.</param>
+/// <param name="type">The class the test method exists in.</param>
+/// <param name="method">The test method.</param>
+public delegate PathInfo DerivePathInfo(string sourceFile, string projectDirectory, Type type, MethodInfo method);

src/Verify.MSTest/DerivePaths/VerifierSettings.cs

@@ -0,0 +1,30 @@
+// ReSharper disable UnusedParameter.Local
+
+namespace VerifyMSTest;
+
+public partial class VerifyBase
+{
+    #region defaultDerivePathInfo
+
+    static DerivePathInfo derivePathInfo = (sourceFile, projectDirectory, type, method) =>
+        new(
+            directory: Path.GetDirectoryName(sourceFile)!,
+            typeName: type.NameWithParent(),
+            methodName: method.Name);
+
+    #endregion
+
+    internal static PathInfo GetPathInfo(string sourceFile, Type type, MethodInfo method) =>
+        derivePathInfo(sourceFile, TargetAssembly.ProjectDir, type, method);
+
+    /// <summary>
+    /// Use custom path information for `.verified.` files.
+    /// </summary>
+    /// <remarks>
+    /// This is sometimes needed on CI systems that move/remove the original source.
+    /// To move to this approach, any existing `.verified.` files will need to be moved to the new directory
+    /// </remarks>
+    /// <param name="derivePathInfo">Custom callback to control the behavior.</param>
+    public static void DerivePathInfo(DerivePathInfo derivePathInfo) =>
+        VerifyBase.derivePathInfo = derivePathInfo;
+}

src/Verify.MSTest/VerifyBase.cs

@@ -32,12 +32,14 @@ InnerVerifier BuildVerifier(VerifySettings settings, string sourceFile)
             throw new($"Could not find method `{type.Name}.{testName}`.");
         }
 
+        var pathInfo = GetPathInfo(sourceFile, type, method);
         return new(
             sourceFile,
             settings,
             type.NameWithParent(),
             method.Name,
-            method.ParameterNames());
+            method.ParameterNames(),
+            pathInfo);
     }
 
     public SettingsTask Verify(