public static Image <TPixel> CompareToReferenceOutput <TPixel>(
this Image <TPixel> image,
ImageComparer comparer,
ITestTextureProvider provider,
FormattableString testOutputDetails,
string extension = "png",
bool appendPixelTypeToFileName = false)
where TPixel : unmanaged, IPixel <TPixel> => image.CompareToReferenceOutput(
comparer,
provider,
(object)testOutputDetails,
extension,
appendPixelTypeToFileName);
public static void DebugSave(
this Image image,
ITestTextureProvider provider,
FormattableString testOutputDetails,
string extension = "png",
bool appendPixelTypeToFileName = false,
bool appendSourceFileOrDescription = false,
IImageEncoder encoder = null) => image.DebugSave(
provider,
(object)testOutputDetails,
extension,
appendPixelTypeToFileName,
appendSourceFileOrDescription,
encoder);
/// <summary>
/// Compares the image against the expected Reference output, throws an exception if the images are not similar enough.
/// The output file should be named identically to the output produced by <see cref="DebugSave{TPixel}(Image{TPixel}, ITestImageProvider, object, string, bool)"/>.
/// </summary>
/// <typeparam name="TPixel">The pixel format.</typeparam>
/// <param name="image">The image which should be compared to the reference image.</param>
/// <param name="provider">The image provider.</param>
/// <param name="testOutputDetails">Details to be concatenated to the test output file, describing the parameters of the test.</param>
/// <param name="extension">The extension</param>
/// <param name="appendPixelTypeToFileName">A boolean indicating whether to append the pixel type to the output file name.</param>
/// <param name="appendSourceFileOrDescription">A boolean indicating whether to append <see cref="ITestTextureProvider.SourceFileOrDescription"/> to the test output file name.</param>
/// <returns>The image.</returns>
public static Image <TPixel> CompareToReferenceOutput <TPixel>(
this Image <TPixel> image,
ITestTextureProvider provider,
object testOutputDetails = null,
string extension = "png",
bool appendPixelTypeToFileName = false,
bool appendSourceFileOrDescription = false)
where TPixel : unmanaged, IPixel <TPixel> => CompareToReferenceOutput(
image,
ImageComparer.Tolerant(),
provider,
testOutputDetails,
extension,
appendPixelTypeToFileName,
appendSourceFileOrDescription);
/// <summary>
/// Saves the image only when not running in the CI server.
/// </summary>
/// <param name="image">The image</param>
/// <param name="provider">The image provider</param>
/// <param name="encoder">The image encoder</param>
/// <param name="testOutputDetails">Details to be concatenated to the test output file, describing the parameters of the test.</param>
/// <param name="appendPixelTypeToFileName">A boolean indicating whether to append the pixel type to the output file name.</param>
public static void DebugSave(
this Image image,
ITestTextureProvider provider,
IImageEncoder encoder,
object testOutputDetails = null,
bool appendPixelTypeToFileName = false)
{
if (TestEnvironment.RunsOnCI)
{
return;
}
// We are running locally then we want to save it out
provider.Utility.SaveTestOutputFile(
image,
encoder: encoder,
testOutputDetails: testOutputDetails,
appendPixelTypeToFileName: appendPixelTypeToFileName);
}
/// <summary>
/// Saves the image only when not running in the CI server.
/// </summary>
/// <param name="image">The image.</param>
/// <param name="provider">The image provider.</param>
/// <param name="testOutputDetails">Details to be concatenated to the test output file, describing the parameters of the test.</param>
/// <param name="extension">The extension.</param>
/// <param name="appendPixelTypeToFileName">A boolean indicating whether to append the pixel type to the output file name.</param>
/// <param name="appendSourceFileOrDescription">A boolean indicating whether to append SourceFileOrDescription to the test output file name.</param>
/// <param name="encoder">Custom encoder to use.</param>
/// <returns>The input image.</returns>
public static Image DebugSave(
this Image image,
ITestTextureProvider provider,
object testOutputDetails = null,
string extension = "png",
bool appendPixelTypeToFileName = false,
bool appendSourceFileOrDescription = false,
IImageEncoder encoder = null)
{
if (TestEnvironment.RunsOnCI)
{
return(image);
}
// We are running locally then we want to save it out
provider.Utility.SaveTestOutputFile(
image,
extension,
testOutputDetails: testOutputDetails,
appendPixelTypeToFileName: appendPixelTypeToFileName,
appendSourceFileOrDescription: appendSourceFileOrDescription,
encoder: encoder);
return(image);
}
public static Image <TPixel> GetReferenceOutputImage <TPixel>(
this ITestTextureProvider provider,
object testOutputDetails = null,
string extension = "png",
bool appendPixelTypeToFileName = false,
bool appendSourceFileOrDescription = false,
IImageDecoder decoder = null)
where TPixel : unmanaged, IPixel <TPixel>
{
string referenceOutputFile = provider.Utility.GetReferenceOutputFileName(
extension,
testOutputDetails,
appendPixelTypeToFileName,
appendSourceFileOrDescription);
if (!File.Exists(referenceOutputFile))
{
throw new FileNotFoundException($"Reference output file {referenceOutputFile} is missing", referenceOutputFile);
}
decoder ??= TestEnvironment.GetReferenceDecoder(referenceOutputFile);
return(Image.Load <TPixel>(referenceOutputFile, decoder));
}
/// <summary>
/// Compares the image against the expected Reference output, throws an exception if the images are not similar enough.
/// The output file should be named identically to the output produced by <see cref="DebugSave{TPixel}(Image{TPixel}, ITestTextureProvider, object, string, bool)"/>.
/// </summary>
/// <typeparam name="TPixel">The pixel format.</typeparam>
/// <param name="image">The image which should be compared to the reference output.</param>
/// <param name="comparer">The <see cref="ImageComparer"/> to use.</param>
/// <param name="provider">The image provider.</param>
/// <param name="testOutputDetails">Details to be concatenated to the test output file, describing the parameters of the test.</param>
/// <param name="extension">The extension</param>
/// <param name="appendPixelTypeToFileName">A boolean indicating whether to append the pixel type to the output file name.</param>
/// <param name="appendSourceFileOrDescription">A boolean indicating whether to append SourceFileOrDescription to the test output file name.</param>
/// <param name="decoder">A custom decoder.</param>
/// <returns>The image.</returns>
public static Image <TPixel> CompareToReferenceOutput <TPixel>(
this Image <TPixel> image,
ImageComparer comparer,
ITestTextureProvider provider,
object testOutputDetails = null,
string extension = "png",
bool appendPixelTypeToFileName = false,
bool appendSourceFileOrDescription = false,
IImageDecoder decoder = null)
where TPixel : unmanaged, IPixel <TPixel>
{
using (Image <TPixel> referenceImage = GetReferenceOutputImage <TPixel>(
provider,
testOutputDetails,
extension,
appendPixelTypeToFileName,
appendSourceFileOrDescription,
decoder))
{
comparer.VerifySimilarity(referenceImage, image);
}
return(image);
}
public static void DebugSave(
this Image image,
ITestTextureProvider provider,
IImageEncoder encoder,
FormattableString testOutputDetails,
bool appendPixelTypeToFileName = false) => image.DebugSave(provider, encoder, (object)testOutputDetails, appendPixelTypeToFileName);
