Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new API to Verify a file outside a test #1300

Merged
merged 2 commits into from
Sep 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions docs/verify-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,13 @@ Use the functionality of VerifyTests outside of a unit test.
```cs
public async Task VerifyExternalFile()
{
var solutionDirectory = AttributeReader.GetSolutionDirectory();
var settings = new VerifySettings();
settings.DisableRequireUniquePrefix();

var sourceFile = Path.Combine(solutionDirectory, "Verify.Tests", "sample.txt");

using var verifier = new InnerVerifier(sourceFile, settings);
await verifier.VerifyFile(sourceFile, null, null);
using var verifier = new InnerVerifier(targetDirectory, "sample", settings);
await verifier.VerifyFile(filePath, null, null);
}
```
<sup><a href='/src/Verify.Tests/InnerVerifyTests.cs#L16-L30' title='Snippet source file'>snippet source</a> | <a href='#snippet-VerifyFileWithoutUnitTest' title='Start of snippet'>anchor</a></sup>
<sup><a href='/src/Verify.Tests/InnerVerifyTests/InnerVerifyTests.cs#L15-L25' title='Snippet source file'>snippet source</a> | <a href='#snippet-VerifyFileWithoutUnitTest' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->


Expand Down
2 changes: 1 addition & 1 deletion src/Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<Project>
<PropertyGroup>
<NoWarn>CS1591;CS0649;xUnit1026;xUnit1013;CS1573;VerifyTestsProjectDir;VerifySetParameters;PolyFillTargetsForNuget</NoWarn>
<Version>26.6.0</Version>
<Version>27.0.0-beta.1</Version>
<ImplicitUsings>enable</ImplicitUsings>
<LangVersion>preview</LangVersion>
<AssemblyVersion>1.0.0</AssemblyVersion>
Expand Down
31 changes: 0 additions & 31 deletions src/Verify.Tests/InnerVerifyTests.cs

This file was deleted.

36 changes: 36 additions & 0 deletions src/Verify.Tests/InnerVerifyTests/InnerVerifyTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
public class InnerVerifyTests
{
static string filePath;
static string targetDirectory;

static InnerVerifyTests()
{
var solutionDirectory = AttributeReader.GetSolutionDirectory();
targetDirectory = Path.Combine(solutionDirectory, "Verify.Tests", "InnerVerifyTests");
filePath = Path.Combine(targetDirectory, "sample.txt");
}

[Fact]

#region VerifyFileWithoutUnitTest

public async Task VerifyExternalFile()
{
var settings = new VerifySettings();
settings.DisableRequireUniquePrefix();
using var verifier = new InnerVerifier(targetDirectory, "sample", settings);
await verifier.VerifyFile(filePath, null, null);
}

#endregion

[Fact]
public async Task VerifyExternalFileLocked()
{
var settings = new VerifySettings();
settings.DisableRequireUniquePrefix();
using var locker = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.Read);
using var verifier = new InnerVerifier(targetDirectory, "sample", settings);
await verifier.VerifyFile(filePath, null, null);
}
}
1 change: 1 addition & 0 deletions src/Verify.Tests/InnerVerifyTests/sample.verified.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Foo
3 changes: 3 additions & 0 deletions src/Verify.Tests/Verify.Tests.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@
<ParentFile>InnerVerifyChecksTests</ParentFile>
<DependentUpon>InnerVerifyChecksTests2.cs</DependentUpon>
</None>
<None Update="InnerVerifyTests\sample.txt">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
</ItemGroup>

<ItemGroup Condition="$(TargetFramework) != 'net8.0'">
Expand Down
37 changes: 37 additions & 0 deletions src/Verify/Verifier/InnerVerifier.cs
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ public InnerVerifier(
/// Initialize a new instance of the <see cref="InnerVerifier" /> class for verifying the entire file (not just a specific type)
/// </summary>
/// <remarks>This constructor is used by 3rd party clients</remarks>
[Obsolete("Use InnerVerifier(string directory, string name, VerifySettings settings)")]
public InnerVerifier(string sourceFile, VerifySettings settings)
{
Guard.NotEmpty(sourceFile);
Expand All @@ -98,6 +99,42 @@ public InnerVerifier(string sourceFile, VerifySettings settings)
getIndexedFileNames = (_, _) => throw new NotImplementedException();
}

/// <summary>
/// Initialize a new instance of the <see cref="InnerVerifier" /> class for verifying the entire file (not just a specific type)
/// </summary>
/// <remarks>This constructor is used by 3rd party clients</remarks>
public InnerVerifier(string directory, string name, VerifySettings settings)
{
Guard.NotEmpty(directory);
Guard.NotEmpty(name);
this.settings = settings;
verifyHasBeenRun = true;
if (settings.Directory != null)
{
throw new("VerifySettings.Directory is not allowed for this API");
}

this.directory = directory;

counter = StartCounter(settings);

IoHelpers.CreateDirectory(directory);

var prefix = Path.Combine(directory, name);
ValidatePrefix(settings, directory);

verifiedFiles = MatchingFileFinder.FindVerified(name, directory);

getFileNames = target =>
new(
target.Extension,
$"{prefix}.received.{target.Extension}",
Path.Combine(directory, $"{prefix}.verified.{target.Extension}")
);

getIndexedFileNames = (_, _) => throw new NotImplementedException();
}

static Counter StartCounter(VerifySettings settings) =>
Counter.Start(
settings.DateCountingEnable,
Expand Down
Loading