make machine name and user name scrubbing less greedy (#569)

VerifyTests · Aug 6, 2022 · abc60ba · abc60ba
1 parent 3fda3a7
commit abc60ba
Show file tree

Hide file tree

Showing 21 changed files with 173 additions and 29 deletions.
diff --git a/docs/named-tuples.md b/docs/named-tuples.md
@@ -19,7 +19,7 @@ Given a method that returns a named tuple:
 static (bool Member1, string Member2, string Member3) MethodWithNamedTuple() =>
     (true, "A", "B");
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1012-L1017' title='Snippet source file'>snippet source</a> | <a href='#snippet-methodwithnamedtuple' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1007-L1012' title='Snippet source file'>snippet source</a> | <a href='#snippet-methodwithnamedtuple' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Can be verified:
@@ -29,7 +29,7 @@ Can be verified:
 ```cs
 await VerifyTuple(() => MethodWithNamedTuple());
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1005-L1009' title='Snippet source file'>snippet source</a> | <a href='#snippet-verifytuple' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1000-L1004' title='Snippet source file'>snippet source</a> | <a href='#snippet-verifytuple' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Resulting in:

diff --git a/docs/serializer-settings.md b/docs/serializer-settings.md
@@ -178,7 +178,7 @@ var target = new GuidTarget
 
 await Verify(target);
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1072-L1085' title='Snippet source file'>snippet source</a> | <a href='#snippet-guid' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1067-L1080' title='Snippet source file'>snippet source</a> | <a href='#snippet-guid' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Results in the following:
@@ -474,7 +474,7 @@ public Task ScopedSerializerFluent()
         .AddExtraSettings(_ => _.TypeNameHandling = TypeNameHandling.All);
 }
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L2226-L2253' title='Snippet source file'>snippet source</a> | <a href='#snippet-scopedserializer' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L2221-L2248' title='Snippet source file'>snippet source</a> | <a href='#snippet-scopedserializer' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Result:
@@ -602,7 +602,7 @@ public Task IgnoreTypeFluent()
         .IgnoreMembersWithType<ToIgnoreStruct>();
 }
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1464-L1569' title='Snippet source file'>snippet source</a> | <a href='#snippet-addignoretype' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1459-L1564' title='Snippet source file'>snippet source</a> | <a href='#snippet-addignoretype' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Or globally:
@@ -612,7 +612,7 @@ Or globally:
 ```cs
 VerifierSettings.IgnoreMembersWithType<ToIgnore>();
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1457-L1461' title='Snippet source file'>snippet source</a> | <a href='#snippet-addignoretypeglobal' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1452-L1456' title='Snippet source file'>snippet source</a> | <a href='#snippet-addignoretypeglobal' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Result:
@@ -683,7 +683,7 @@ public Task AddIgnoreInstanceFluent()
         .IgnoreInstance<Instance>(_ => _.Property == "Ignore");
 }
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1385-L1424' title='Snippet source file'>snippet source</a> | <a href='#snippet-addignoreinstance' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1380-L1419' title='Snippet source file'>snippet source</a> | <a href='#snippet-addignoreinstance' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Or globally:
@@ -693,7 +693,7 @@ Or globally:
 ```cs
 VerifierSettings.IgnoreInstance<Instance>(_ => _.Property == "Ignore");
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1378-L1382' title='Snippet source file'>snippet source</a> | <a href='#snippet-addignoreinstanceglobal' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1373-L1377' title='Snippet source file'>snippet source</a> | <a href='#snippet-addignoreinstanceglobal' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Result:
@@ -736,7 +736,7 @@ public Task WithObsoleteProp()
     return Verify(target);
 }
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L2190-L2210' title='Snippet source file'>snippet source</a> | <a href='#snippet-withobsoleteprop' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L2185-L2205' title='Snippet source file'>snippet source</a> | <a href='#snippet-withobsoleteprop' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Result:
@@ -784,7 +784,7 @@ public Task WithObsoletePropIncludedFluent()
         .IncludeObsoletes();
 }
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L2161-L2188' title='Snippet source file'>snippet source</a> | <a href='#snippet-withobsoletepropincluded' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L2156-L2183' title='Snippet source file'>snippet source</a> | <a href='#snippet-withobsoletepropincluded' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Or globally:
@@ -794,7 +794,7 @@ Or globally:
 ```cs
 VerifierSettings.IncludeObsoletes();
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L2154-L2158' title='Snippet source file'>snippet source</a> | <a href='#snippet-withobsoletepropincludedglobally' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L2149-L2153' title='Snippet source file'>snippet source</a> | <a href='#snippet-withobsoletepropincludedglobally' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Result:
@@ -855,7 +855,7 @@ public Task IgnoreMemberByExpressionFluent()
             _ => _.PropertyThatThrows);
 }
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1749-L1788' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignorememberbyexpression' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1744-L1783' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignorememberbyexpression' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Or globally
@@ -870,7 +870,7 @@ VerifierSettings.IgnoreMembers<IgnoreExplicitTarget>(
     _ => _.GetOnlyProperty,
     _ => _.PropertyThatThrows);
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1737-L1746' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignorememberbyexpressionglobal' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1732-L1741' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignorememberbyexpressionglobal' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Result:
@@ -944,7 +944,7 @@ public Task IgnoreMemberByNameFluent()
         .IgnoreMember<IgnoreExplicitTarget>(_ => _.PropertyThatThrows);
 }
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1841-L1894' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignorememberbyname' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1836-L1889' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignorememberbyname' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Or globally:
@@ -964,7 +964,7 @@ VerifierSettings.IgnoreMember<IgnoreExplicitTarget>("Field");
 // For a specific type with expression
 VerifierSettings.IgnoreMember<IgnoreExplicitTarget>(_ => _.PropertyThatThrows);
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1824-L1838' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignorememberbynameglobal' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1819-L1833' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignorememberbynameglobal' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Result:
@@ -1011,7 +1011,7 @@ public Task CustomExceptionPropFluent()
         .IgnoreMembersThatThrow<CustomException>();
 }
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L2046-L2065' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignoremembersthatthrow' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L2041-L2060' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignoremembersthatthrow' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Or globally:
@@ -1021,7 +1021,7 @@ Or globally:
 ```cs
 VerifierSettings.IgnoreMembersThatThrow<CustomException>();
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L2039-L2043' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignoremembersthatthrowglobal' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L2034-L2038' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignoremembersthatthrowglobal' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Result:
@@ -1058,7 +1058,7 @@ public Task ExceptionMessagePropFluent()
         .IgnoreMembersThatThrow<Exception>(_ => _.Message == "Ignore");
 }
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1251-L1272' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignoremembersthatthrowexpression' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1246-L1267' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignoremembersthatthrowexpression' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Or globally:
@@ -1068,7 +1068,7 @@ Or globally:
 ```cs
 VerifierSettings.IgnoreMembersThatThrow<Exception>(_ => _.Message == "Ignore");
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1244-L1248' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignoremembersthatthrowexpressionglobal' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1239-L1243' title='Snippet source file'>snippet source</a> | <a href='#snippet-ignoremembersthatthrowexpressionglobal' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Result:
@@ -1234,7 +1234,7 @@ public Task MemberConverterByExpression()
     return Verify(input);
 }
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1790-L1814' title='Snippet source file'>snippet source</a> | <a href='#snippet-memberconverter' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1785-L1809' title='Snippet source file'>snippet source</a> | <a href='#snippet-memberconverter' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 

diff --git a/readme.md b/readme.md
@@ -349,7 +349,7 @@ public Task VerifyJsonJToken()
     return VerifyJson(target);
 }
 ```
-<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1970-L2002' title='Snippet source file'>snippet source</a> | <a href='#snippet-verifyjson' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Serialization/SerializationTests.cs#L1965-L1997' title='Snippet source file'>snippet source</a> | <a href='#snippet-verifyjson' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Results in:

diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineName.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineName.verified.txt
@@ -0,0 +1 @@
+TheMachineName
diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineNameInValidAfter.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineNameInValidAfter.verified.txt
@@ -0,0 +1 @@
+FakeMachineNameA
diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineNameInValidBefore.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineNameInValidBefore.verified.txt
@@ -0,0 +1 @@
+AFakeMachineName
diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineNameInValidWrapped.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineNameInValidWrapped.verified.txt
@@ -0,0 +1 @@
+AFakeMachineNameA
diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineNameValidAfter.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineNameValidAfter.verified.txt
@@ -0,0 +1 @@
+TheMachineName 
diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineNameValidBefore.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineNameValidBefore.verified.txt
@@ -0,0 +1 @@
+ TheMachineName
diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineNameValidWrapped.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubMachineNameValidWrapped.verified.txt
@@ -0,0 +1 @@
+ TheMachineName 
diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserName.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserName.verified.txt
@@ -0,0 +1 @@
+TheUserName
diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserNameInValidAfter.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserNameInValidAfter.verified.txt
@@ -0,0 +1 @@
+FakeUserNameA
diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserNameInValidBefore.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserNameInValidBefore.verified.txt
@@ -0,0 +1 @@
+AFakeUserName
diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserNameInValidWrapped.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserNameInValidWrapped.verified.txt
@@ -0,0 +1 @@
+AFakeUserNameA
diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserNameValidAfter.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserNameValidAfter.verified.txt
@@ -0,0 +1 @@
+TheUserName 
diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserNameValidBefore.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserNameValidBefore.verified.txt
@@ -0,0 +1 @@
+ TheUserName
diff --git a/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserNameValidWrapped.verified.txt b/src/ApplyScrubbersTests/ApplyScrubbersTests.ScrubUserNameValidWrapped.verified.txt
@@ -0,0 +1 @@
+ TheUserName 
diff --git a/src/ApplyScrubbersTests/DisableDirScrubbingTests.cs b/src/ApplyScrubbersTests/DisableDirScrubbingTests.cs
@@ -1,6 +1,9 @@
 [UsesVerify]
 public class ApplyScrubbersTests
 {
+    public ApplyScrubbersTests() =>
+        Scrubbers.ResetReplacements("FakeMachineName", "FakeUserName");
+
     [Theory]
     [InlineData("/", "/project", "/,/project")]
     [InlineData("/solution", "/project", "/solution,/project")]
@@ -23,4 +26,74 @@ public void Apply_solution_and_project_directories_scrubbers(
         // Assert
         Assert.Equal("{SolutionDirectory},{ProjectDirectory}", builder.ToString());
     }
+
+    [Fact]
+    public Task ScrubUserName() =>
+        Verify("FakeUserName")
+            .ScrubUserName();
+
+    [Fact]
+    public Task ScrubUserNameValidBefore() =>
+        Verify(" FakeUserName")
+            .ScrubUserName();
+
+    [Fact]
+    public Task ScrubUserNameValidAfter() =>
+        Verify("FakeUserName ")
+            .ScrubUserName();
+
+    [Fact]
+    public Task ScrubUserNameValidWrapped() =>
+        Verify(" FakeUserName ")
+            .ScrubUserName();
+
+    [Fact]
+    public Task ScrubMachineName() =>
+        Verify("FakeMachineName")
+            .ScrubMachineName();
+
+    [Fact]
+    public Task ScrubMachineNameValidBefore() =>
+        Verify(" FakeMachineName")
+            .ScrubMachineName();
+
+    [Fact]
+    public Task ScrubMachineNameValidAfter() =>
+        Verify("FakeMachineName ")
+            .ScrubMachineName();
+
+    [Fact]
+    public Task ScrubMachineNameValidWrapped() =>
+        Verify(" FakeMachineName ")
+            .ScrubMachineName();
+
+    [Fact]
+    public Task ScrubUserNameInValidBefore() =>
+        Verify("AFakeUserName")
+        .ScrubUserName();
+
+    [Fact]
+    public Task ScrubUserNameInValidAfter() =>
+        Verify("FakeUserNameA")
+        .ScrubUserName();
+
+    [Fact]
+    public Task ScrubUserNameInValidWrapped() =>
+        Verify("AFakeUserNameA")
+        .ScrubUserName();
+
+    [Fact]
+    public Task ScrubMachineNameInValidBefore() =>
+        Verify("AFakeMachineName")
+        .ScrubMachineName();
+
+    [Fact]
+    public Task ScrubMachineNameInValidAfter() =>
+        Verify("FakeMachineNameA")
+        .ScrubMachineName();
+
+    [Fact]
+    public Task ScrubMachineNameInValidWrapped() =>
+        Verify("AFakeMachineNameA")
+        .ScrubMachineName();
 }
diff --git a/src/Verify.Tests/Serialization/SerializationTests.ScrubUserName.verified.txt b/src/Verify.Tests/Serialization/SerializationTests.ScrubUserName.verified.txt
diff --git a/src/Verify.Tests/Serialization/SerializationTests.cs b/src/Verify.Tests/Serialization/SerializationTests.cs
@@ -924,11 +924,6 @@ public Task ScrubCurrentDirectory()
         });
     }
 
-    [Fact]
-    public Task ScrubUserName() =>
-        Verify(Environment.UserName)
-        .ScrubUserName();
-
     [Fact]
     public Task MoreSpecificScrubberShouldOverride()
     {