tsai
/
ImageSharp
mirror of https://github.com/SixLabors/ImageSharp
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

introducing the "doNotAppendPixelType" feature

pull/298/head
Anton Firszov 9 years ago
parent
cd3f39130a
commit
59705eeefb
5 changed files with 80 additions and 55 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 3
      tests/ImageSharp.Tests/Formats/Jpg/JpegDecoderTests.cs
  2. 82
      tests/ImageSharp.Tests/TestUtilities/ImagingTestCaseUtility.cs
  3. 35
      tests/ImageSharp.Tests/TestUtilities/TestImageExtensions.cs
  4. 13
      tests/ImageSharp.Tests/TestUtilities/Tests/TestImageExtensionsTests.cs
  5. 2
      tests/Images/External

3
tests/ImageSharp.Tests/Formats/Jpg/JpegDecoderTests.cs
View File

@ -37,7 +37,8 @@ namespace ImageSharp.Tests
{
using (Image<TPixel> image = provider.GetImage())
{
image.CompareToReferenceOutput(provider, VeryTolerantJpegComparer);
image.DebugSave(provider);
image.CompareToReferenceOutput(provider, VeryTolerantJpegComparer, appendPixelTypeToFileName: false);
}
}

82
tests/ImageSharp.Tests/TestUtilities/ImagingTestCaseUtility.cs
View File

@ -23,100 +23,106 @@ namespace ImageSharp.Tests
/// <summary>
/// Name of the TPixel in the owner <see cref="TestImageProvider{TPixel}"/>
/// </summary>
public string PixelTypeName { get; set; } = String.Empty;
public string PixelTypeName { get; set; } = string.Empty;
/// <summary>
/// The name of the file which is provided by <see cref="TestImageProvider{TPixel}"/>
/// Or a short string describing the image in the case of a non-file based image provider.
/// </summary>
public string SourceFileOrDescription { get; set; } = String.Empty;
public string SourceFileOrDescription { get; set; } = string.Empty;
/// <summary>
/// By default this is the name of the test class, but it's possible to change it
/// </summary>
public string TestGroupName { get; set; } = String.Empty;
public string TestGroupName { get; set; } = string.Empty;
/// <summary>
/// The name of the test case (by default)
/// </summary>
public string TestName { get; set; } = String.Empty;
public string TestName { get; set; } = string.Empty;
private string GetTestOutputFileNameImpl(string extension, string tag)
private string GetTestOutputFileNameImpl(string extension, string details, bool appendPixelTypeToFileName)
{
string fn = String.Empty;
string fn = string.Empty;
if (String.IsNullOrWhiteSpace(extension))
if (string.IsNullOrWhiteSpace(extension))
{
extension = null;
}
fn = Path.GetFileNameWithoutExtension(this.SourceFileOrDescription);
if (String.IsNullOrWhiteSpace(extension))
if (string.IsNullOrWhiteSpace(extension))
{
extension = Path.GetExtension(this.SourceFileOrDescription);
}
if (String.IsNullOrWhiteSpace(extension))
if (string.IsNullOrWhiteSpace(extension))
{
extension = ".bmp";
}
extension = extension.ToLower();
if (extension[0] != '.')
{
extension = '.' + extension;
}
if (fn != String.Empty) fn = '_' + fn;
if (fn != string.Empty) fn = '_' + fn;
string pixName = "";
string pixName = this.PixelTypeName;
if (pixName != String.Empty)
if (appendPixelTypeToFileName)
{
pixName = '_' + pixName;
pixName = this.PixelTypeName;
if (pixName != string.Empty)
{
pixName = '_' + pixName;
}
}
tag = tag ?? String.Empty;
if (tag != String.Empty)
details = details ?? string.Empty;
if (details != string.Empty)
{
tag = '_' + tag;
details = '_' + details;
}
return $"{this.GetTestOutputDir()}/{this.TestName}{pixName}{fn}{tag}{extension}";
return $"{this.GetTestOutputDir()}/{this.TestName}{pixName}{fn}{details}{extension}";
}
/// <summary>
/// Gets the recommended file name for the output of the test
/// </summary>
/// <param name="extension">The required extension</param>
/// <param name="settings">The settings modifying the output path</param>
/// <param name="testOutputDetails">The settings modifying the output path</param>
/// <param name="appendPixelTypeToFileName">A boolean indicating whether to append the pixel type to output file name.</param>
/// <returns>The file test name</returns>
public string GetTestOutputFileName(string extension = null, object settings = null)
public string GetTestOutputFileName(string extension = null, object testOutputDetails = null, bool appendPixelTypeToFileName = true)
{
string tag = null;
string s = settings as string;
string detailsString = null;
string s = testOutputDetails as string;
if (s != null)
{
tag = s;
detailsString = s;
}
else if (settings != null)
else if (testOutputDetails != null)
{
Type type = settings.GetType();
Type type = testOutputDetails.GetType();
TypeInfo info = type.GetTypeInfo();
if (info.IsPrimitive || info.IsEnum || type == typeof(decimal))
{
tag = settings.ToString();
detailsString = testOutputDetails.ToString();
}
else
{
IEnumerable<PropertyInfo> properties = settings.GetType().GetRuntimeProperties();
IEnumerable<PropertyInfo> properties = testOutputDetails.GetType().GetRuntimeProperties();
tag = String.Join("_", properties.ToDictionary(x => x.Name, x => x.GetValue(settings)).Select(x => $"{x.Key}-{x.Value}"));
detailsString = String.Join("_", properties.ToDictionary(x => x.Name, x => x.GetValue(testOutputDetails)).Select(x => $"{x.Key}-{x.Value}"));
}
}
return this.GetTestOutputFileNameImpl(extension, tag);
return this.GetTestOutputFileNameImpl(extension, detailsString, appendPixelTypeToFileName);
}
@ -132,10 +138,11 @@ namespace ImageSharp.Tests
string extension = null,
IImageEncoder encoder = null,
object testOutputDetails = null,
bool grayscale = false)
bool grayscale = false,
bool appendPixelTypeToFileName = true)
where TPixel : struct, IPixel<TPixel>
{
string path = this.GetTestOutputFileName(extension: extension, settings: testOutputDetails);
string path = this.GetTestOutputFileName(extension, testOutputDetails, appendPixelTypeToFileName);
string extension1 = Path.GetExtension(path);
encoder = encoder ?? GetImageFormatByExtension(extension1, grayscale);
@ -145,8 +152,15 @@ namespace ImageSharp.Tests
}
}
internal string GetReferenceOutputFileName(string extension = null, object settings = null) =>
TestEnvironment.GetReferenceOutputFileName(this.GetTestOutputFileName(extension, settings));
internal string GetReferenceOutputFileName(
string extension,
object settings,
bool appendPixelTypeToFileName)
{
return TestEnvironment.GetReferenceOutputFileName(
this.GetTestOutputFileName(extension, settings, appendPixelTypeToFileName)
);
}
internal void Init(string typeName, string methodName)
{

35
tests/ImageSharp.Tests/TestUtilities/TestImageExtensions.cs
View File

@ -22,13 +22,15 @@ namespace ImageSharp.Tests
/// <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="grayscale">A boolean indicating whether we should save a smaller in size.</param>
/// <param name="grayscale">A boolean indicating whether we should save a smaller in size.</param>
/// <param name="appendPixelTypeToFileName">A boolean indicating whether to append the pixel type to the output file name.</param>
public static Image<TPixel> DebugSave<TPixel>(
this Image<TPixel> image,
ITestImageProvider provider,
object testOutputDetails = null,
string extension = "png",
bool grayscale = false)
bool grayscale = false,
bool appendPixelTypeToFileName = true)
where TPixel : struct, IPixel<TPixel>
{
if (TestEnvironment.RunsOnCI)
@ -41,7 +43,8 @@ namespace ImageSharp.Tests
image,
extension,
testOutputDetails: testOutputDetails,
grayscale: grayscale);
grayscale: grayscale,
appendPixelTypeToFileName: appendPixelTypeToFileName);
return image;
}
@ -52,17 +55,18 @@ namespace ImageSharp.Tests
/// <typeparam name="TPixel">The pixel format</typeparam>
/// <param name="image">The image</param>
/// <param name="provider">The image provider</param>
/// <param name="comparer">The <see cref="ImageComparer"/> to use</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="grayscale">A boolean indicating whether we should debug save + compare against a grayscale image, smaller in size.</param>
/// <param name="appendPixelTypeToFileName">A boolean indicating whether to append the pixel type to the output file name.</param>
/// <returns></returns>
public static Image<TPixel> CompareToReferenceOutput<TPixel>(
this Image<TPixel> image,
ITestImageProvider provider,
object testOutputDetails = null,
string extension = "png",
bool grayscale = false)
bool grayscale = false,
bool appendPixelTypeToFileName = true)
where TPixel : struct, IPixel<TPixel>
{
return CompareToReferenceOutput(
@ -71,7 +75,8 @@ namespace ImageSharp.Tests
ImageComparer.Tolerant(),
testOutputDetails,
extension,
grayscale);
grayscale,
appendPixelTypeToFileName);
}
/// <summary>
@ -85,6 +90,7 @@ namespace ImageSharp.Tests
/// <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="grayscale">A boolean indicating whether we should debug save + compare against a grayscale image, smaller in size.</param>
/// <param name="appendPixelTypeToFileName">A boolean indicating whether to append the pixel type to the output file name.</param>
/// <returns></returns>
public static Image<TPixel> CompareToReferenceOutput<TPixel>(
this Image<TPixel> image,
@ -92,21 +98,12 @@ namespace ImageSharp.Tests
ImageComparer comparer,
object testOutputDetails = null,
string extension = "png",
bool grayscale = false)
bool grayscale = false,
bool appendPixelTypeToFileName = true)
where TPixel : struct, IPixel<TPixel>
{
string referenceOutputFile = provider.Utility.GetReferenceOutputFileName(extension, testOutputDetails);
extension = extension.ToLower();
if (!TestEnvironment.RunsOnCI)
{
provider.Utility.SaveTestOutputFile(
image,
extension,
testOutputDetails: testOutputDetails,
grayscale: grayscale);
}
string referenceOutputFile = provider.Utility.GetReferenceOutputFileName(extension, testOutputDetails, appendPixelTypeToFileName);
if (!File.Exists(referenceOutputFile))
{
throw new Exception("Reference output file missing: " + referenceOutputFile);

13
tests/ImageSharp.Tests/TestUtilities/Tests/TestImageExtensionsTests.cs
View File

@ -36,6 +36,19 @@ namespace ImageSharp.Tests
}
}
[Theory]
[WithSolidFilledImages(10, 10, 0, 0, 255, PixelTypes.Rgba32)]
public void CompareToReferenceOutput_DoNotAppendPixelType<TPixel>(
TestImageProvider<TPixel> provider)
where TPixel : struct, IPixel<TPixel>
{
using (Image<TPixel> image = provider.GetImage())
{
image.DebugSave(provider, appendPixelTypeToFileName: false);
image.CompareToReferenceOutput(provider, appendPixelTypeToFileName: false);
}
}
[Theory]
[WithSolidFilledImages(10, 10, 0, 0, 255, PixelTypes.Rgba32)]
public void CompareToReferenceOutput_WhenReferenceFileMissing_Throws<TPixel>(TestImageProvider<TPixel> provider)

2
tests/Images/External

@ -1 +1 @@
Subproject commit f01bd8ace62e69aa9be9fcdf8bc00789d8d75a53
Subproject commit d5a93a6e271c05a6549730acafa7092ac2dc7f03
Write Preview
Loading…
Cancel
Save