split out default_render and default_equality

Author: johnnychen94

src/ReferenceTests.jl

@@ -18,7 +18,6 @@ export
 include("utils.jl")
 include("test_reference.jl")
 include("core.jl")
-include("handlers.jl")
 include("equality_metrics.jl")
 
 end # module

src/core.jl

@@ -92,6 +92,25 @@ function render(mode::RenderMode, actual)
     println("-------------------------------")
 end
 
+
+default_rendermode(::TestMode, ::File, actual) = BeforeAfterFull()
+
+# plain TXT
+default_rendermode(::TestMode, ::File{format"TXT"}, actual) = BeforeAfterLimited()
+default_rendermode(::TestMode, ::File{format"TXT"}, actual::AbstractString) = Diff()
+default_rendermode(::TestMode, ::File{format"TXT"}, actual::Number) = BeforeAfterFull()
+
+# SHA256
+default_rendermode(::TestMode, ::File{format"SHA256"}, actual) = BeforeAfterFull()
+
+# images
+function default_rendermode(::TestMode, ::File, actual::AbstractArray{<:Colorant})
+    return BeforeAfterImage()
+end
+function default_rendermode(::TestMode, ::File{format"TXT"}, actual::AbstractArray{<:Colorant})
+    return BeforeAfterFull()
+end
+
 #######################################
 # IO
 # Right now this basically just extends FileIO to support some things as text files
@@ -118,17 +137,69 @@ function savefile(file::TextFile, content)
     write(file.filename, content)
 end
 
+#######################################
+# Preprocess
+
+preprocess(::File, actual; kw...) = actual
+
+# plain TXT
+preprocess(::File{format"TXT"}, actual; kw...) = string(actual)
+preprocess(::File{format"TXT"}, actual::Number; kw...) = actual
+function preprocess(::File{format"TXT"}, actual::AbstractArray{<:AbstractString}; kw...)
+    return join(actual, '\n')
+end
+
+# SHA256
+preprocess(::File{format"SHA256"}, actual; kw...) = bytes2hex(sha256(string(actual)))
+
+# images
+function preprocess(
+    ::File{format"TXT"}, actual::AbstractArray{<:Colorant};
+    size = (20,40), kw...)
+
+    strs = @withcolor ImageInTerminal.encodeimg(
+        ImageInTerminal.SmallBlocks(),
+        ImageInTerminal.TermColor256(),
+        actual,
+        size...)[1]
+    str = join(strs,'\n')
+end
+
+function preprocess(::File{format"SHA256"}, actual::AbstractArray{<:Colorant}; kw...)
+    size_str = bytes2hex(sha256(reinterpret(UInt8,[map(Int64,size(actual))...])))
+    img_str = bytes2hex(sha256(reinterpret(UInt8,vec(rawview(channelview(actual))))))
+
+    return size_str * img_str
+end
+
+
 ##########################################
 
 # Final function
 # all other functions should hit one of this eventually
 # Which handles the actual testing and user prompting
 
-function _test_reference(equiv, rendermode, file::File, actual::T) where T
-    path = file.filename
-    dir, filename = splitdir(path)
+function test_reference(
+    filename::AbstractString, actual;
+    by = nothing, render = nothing, kw...)
+
+    test_reference(query_extended(filename), actual, render, by; kw...)
+end
+
+function test_reference(
+    file::File,
+    actual::T,
+    rendermode::Union{RenderMode, Nothing}=nothing,
+    equiv::Union{Function, Nothing}=nothing;
+    kw...) where T
+
     testmode = TESTMODE()
+    if isnothing(rendermode)
+        rendermode = default_rendermode(testmode, file, actual)
+    end
 
+    path = file.filename
+    dir, filename = splitdir(path)
     if !isfile(path)
         println("Reference file for \"$filename\" does not exist.")
         render(rendermode, actual)
@@ -141,8 +212,14 @@ function _test_reference(equiv, rendermode, file::File, actual::T) where T
     end
 
     # file exists
+    actual = preprocess(file, actual; kw...)
     reference = loadfile(T, file)
 
+    if isnothing(equiv)
+        # generally, `reference` and `actual` are of the same type after preprocessing
+        equiv = default_equality(typeof(reference), typeof(actual))
+    end
+
     if equiv(reference, actual)
         @test true
     else

src/equality_metrics.jl

@@ -1,8 +1,14 @@
+default_equality(reference, actual) = isequal
+function default_equality(
+    reference::AbstractArray{<:Colorant},
+    actual::AbstractArray{<:Colorant})
+
+    psnr_equality()(reference, actual)
+end
+
 # ---------------------------------
 # Image
 
-default_image_equality(reference, actual) = psnr_equality()(reference, actual)
-
 """
     psnr_equality(threshold=25) -> f
 

src/handlers.jl

@@ -83,10 +83,6 @@ macro test_reference(reference, actual, kws...)
     expr
 end
 
-function test_reference(filename::AbstractString, actual; kw...)
-    test_reference(query_extended(filename), actual; kw...)
-end
-
 function query_extended(filename)
     file, ext = splitext(filename)
     # TODO: make this less hacky