WoofWare.Expect
0.2.2
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package WoofWare.Expect --version 0.2.2
NuGet\Install-Package WoofWare.Expect -Version 0.2.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="WoofWare.Expect" Version="0.2.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="WoofWare.Expect" Version="0.2.2" />
<PackageReference Include="WoofWare.Expect" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add WoofWare.Expect --version 0.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: WoofWare.Expect, 0.2.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package WoofWare.Expect@0.2.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=WoofWare.Expect&version=0.2.2
#tool nuget:?package=WoofWare.Expect&version=0.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
WoofWare.Expect
An expect-testing library for F#. (Also known as "snapshot testing".)
Current status
The basic mechanism works. Snapshot updating is vibe-coded with Opus 4 and is purely text-based; I didn't want to use the F# compiler services because that's a pretty heavyweight dependency which should be confined to a separate test runner entity. It's not very well tested, and I expect it to be kind of brittle.
How to use
See the tests.
[<Test>]
let ``This test fails: JSON documents are not equal`` () =
expect {
snapshotJson "123"
return 124
}
[<Test>]
let ``This test passes: JSON documents are equal`` () =
expect {
snapshotJson " 123 "
return 123
}
[<Test>]
let ``This test fails: plain text comparison of ToString`` () =
expect {
snapshot " 123 "
return 123
}
If a snapshot is failing, add a ' to the expect builder and rerun.
The rerun will throw, but it will update the snapshot; then remove the ' again to put the test back into "assert snapshot" mode.
[<Test>]
let ``Example of automatically updating`` () =
// This test fails...
expect {
snapshotJson "123"
return 124
}
// so make this change:
expect' {
snapshotJson "123"
return 124
}
// and rerunning converts the result to this:
expect' {
snapshotJson @"124"
return 124
}
// That test will always throw, because it's not in "assertion" mode but in "update" mode;
// so finally, remove the `'` again. This test now passes!
expect {
snapshotJson @"124"
return 124
}
Limitations
- The snapshot updating mechanism requires you to use verbatim string literals. While the test assertions will work correctly if you do
snapshot ("foo" + "bar" + f 3), for example, the updating code is liable to do something undefined in that case. Also do not use format strings ($"blah").
Licence
MIT.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- FSharp.Core (>= 4.7.0)
- FSharp.SystemTextJson (>= 1.4.36)
- System.Text.Json (>= 9.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.