/// <summary>
/// Creates a json snapshot of the given object and compares it with the
/// already existing snapshot of the test.
/// If no snapshot exists, a new snapshot will be created from the current result
/// and saved under a certain file path, which will shown within the test message.
/// </summary>
/// <param name="currentResult">The object to match.</param>
/// <param name="snapshotFullName">
/// The full name of a snapshot with folder and file name.</param>
/// <param name="matchOptions">
/// Additional compare actions, which can be applied during the snapshot comparison.
/// </param>
public static void Match(
object currentResult,
SnapshotFullName snapshotFullName,
Func <MatchOptions, MatchOptions> matchOptions = null)
{
Snapshooter.AssertSnapshot(currentResult, snapshotFullName, matchOptions);
}
/// <summary>
/// Creates a json snapshot of the given object and compares it with the
/// already existing snapshot of the test.
/// If no snapshot exists, a new snapshot will be created from the current result
/// and saved under a certain file path, which will shown within the test message.
/// </summary>
/// <param name="currentResult">The object to match.</param>
/// <param name="matchOptions">
/// Additional compare actions, which can be applied during the snapshot comparison
/// </param>
public static void Match(
object currentResult,
Func <MatchOptions, MatchOptions> matchOptions = null)
{
Snapshooter.AssertSnapshot(currentResult, FullName(), matchOptions);
_snapshotName = new AsyncLocal <SnapshotFullName>();
}
/// <summary>
/// Matches the current result/object with the actual snapshot of the test. If
/// no snapshot exists, a new snapshot will be created from the current result
/// and saved under a certain file path, which will shown in the assert exception.
/// </summary>
/// <typeparam name="T">The type of the result/object to match.</typeparam>
/// <param name="currentResult">The object to match.</param>
/// /// <param name="snapshotName">
/// The name of the snapshot. If not set, then the snapshotname
/// will be evaluated automatically.
/// </param>
/// <param name="snapshotNameExtension">
/// The snapshot name extension will extend the generated snapshot name with
/// this given extensions. It can be used to make a snapshot name even more
/// specific.
/// Example:
/// Generated Snapshotname = 'NumberAdditionTest'
/// Snapshot name extension = '5', '6', 'Result', '11'
/// Result: 'NumberAdditionTest_5_6_Result_11'
/// </param>
/// <param name="matchOptions">
/// Additional compare actions, which can be applied during the comparison
/// </param>
public static void Match(object currentResult,
string snapshotName,
SnapshotNameExtension snapshotNameExtension,
Func <MatchOptions, MatchOptions> matchOptions = null)
{
SnapshotFullName snapshotFullName = FullName(snapshotName, snapshotNameExtension);
Snapshooter.AssertSnapshot(currentResult, snapshotFullName, matchOptions);
}
/// <summary>
/// Resolves the snapshot name for the running unit test.
/// The default generated snapshot name can be overwritten
/// by the given snapshot name.
/// </summary>
/// <param name="snapshotName">
/// The snapshot name given by the user. This snapshot name will overwrite
/// the automatically generated snapshot name.
/// </param>
/// <returns>The full name of a snapshot.</returns>
public static SnapshotFullName FullName(string snapshotName)
{
SnapshotFullName fullName = _snapshotName.Value;
if (fullName is null)
{
fullName = Snapshooter.ResolveSnapshotFullName(snapshotName);
_snapshotName.Value = fullName;
}
return(fullName);
}
/// <summary>
/// Resolves the snapshot name for the running unit test.
/// The default generated snapshot name can be extended by
/// the snapshot name extensions.
/// </summary>
/// <param name="snapshotNameExtension">
/// The snapshot name extension will extend the snapshot name with
/// this given extensions. It can be used to make a snapshot name even more
/// specific.
/// Example:
/// Snapshot name = 'NumberAdditionTest'
/// Snapshot name extension = '5', '6', 'Result', '11'
/// Result: 'NumberAdditionTest_5_6_Result_11'
/// </param>
/// <returns>The full name of a snapshot.</returns>
public static SnapshotFullName FullName(
SnapshotNameExtension snapshotNameExtension)
{
SnapshotFullName fullName = _snapshotName.Value;
if (fullName is null)
{
fullName = Snapshooter.ResolveSnapshotFullName(
snapshotNameExtension: snapshotNameExtension);
_snapshotName.Value = fullName;
}
return(fullName);
}
/// <summary>
/// Creates a json snapshot of the given object and compares it with the
/// already existing snapshot of the test.
/// If no snapshot exists, a new snapshot will be created from the current result
/// and saved under a certain file path, which will shown within the test message.
/// </summary>
/// <param name="currentResult">The object to match.</param>
/// <param name="snapshotFullName">
/// The full name of a snapshot with folder and file name.</param>
/// <param name="matchOptions">
/// Additional compare actions, which can be applied during the snapshot comparison.
/// </param>
public static void Match(
object currentResult,
SnapshotFullName snapshotFullName,
Func <MatchOptions, MatchOptions> matchOptions = null)
{
try
{
Snapshooter.AssertSnapshot(currentResult, snapshotFullName, matchOptions);
}
finally
{
_snapshotName = new AsyncLocal <SnapshotFullName>();
}
}
/// <summary>
/// Resolves the snapshot name for the running unit test.
/// The default generated snapshot name can either be overwritten
/// with a given snapshot name, or can be extended by the snapshot name extensions,
/// or both.
/// </summary>
/// <param name="snapshotName">
/// The snapshot name given by the user, this snapshot name will overwrite
/// the automatically generated snapshot name.
/// </param>
/// <param name="snapshotNameExtension">
/// The snapshot name extension will extend the snapshot name with
/// this given extensions. It can be used to make a snapshot name even more
/// specific.
/// Example:
/// Snapshot name = 'NumberAdditionTest'
/// Snapshot name extension = '5', '6', 'Result', '11'
/// Result: 'NumberAdditionTest_5_6_Result_11'
/// </param>
/// <returns>The full name of a snapshot.</returns>
public static SnapshotFullName FullName(
string snapshotName, SnapshotNameExtension snapshotNameExtension)
{
return(Snapshooter.ResolveSnapshotFullName(snapshotName, snapshotNameExtension));
}
/// <summary>
/// Resolves the snapshot name for the running unit test.
/// The default generated snapshot name can be overwritten
/// by the given snapshot name.
/// </summary>
/// <param name="snapshotName">
/// The snapshot name given by the user. This snapshot name will overwrite
/// the automatically generated snapshot name.
/// </param>
/// <returns>The full name of a snapshot.</returns>
public static SnapshotFullName FullName(string snapshotName)
{
return(Snapshooter.ResolveSnapshotFullName(snapshotName));
}
/// <summary>
/// Resolves automatically the snapshot name for the running unit test.
/// </summary>
/// <returns>The full name of a snapshot.</returns>
public static SnapshotFullName FullName()
{
return(Snapshooter.ResolveSnapshotFullName());
}