Skip to content

Commit 2689c14

Browse files
johnnychen94johnnychen94
committed
rework default_rendermode and add tests for render
The previous `default_rendermode(format, data)` is problematic that the render pipeline is showing the original data instead of the encoded data. That said, `default_rendermode(::SHA256, img)` is wrongly set to `BeforeAfterFull` -- we shoud never print the whole image array.
1 parent afc31d4 commit 2689c14

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+663
-44
lines changed

‎src/render.jl‎

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -9,57 +9,57 @@ struct BeforeAfterLimited <: BeforeAfter end
99
struct BeforeAfterFull <: BeforeAfter end
1010
struct BeforeAfterImage <: BeforeAfter end
1111

12-
render_item(::RenderMode, item) = println(item)
13-
function render_item(::BeforeAfterLimited, item)
14-
show(IOContext(stdout, :limit=>true, :displaysize=>(20,80)), "text/plain", item)
15-
println()
12+
render_item(mode::RenderMode, item) = render_item(stdout, mode, item)
13+
render_item(io::IO, ::RenderMode, item) = println(io, item)
14+
function render_item(io::IO, ::BeforeAfterLimited, item)
15+
show(IOContext(io, :limit=>true, :displaysize=>(20,80)), "text/plain", item)
16+
println(io)
1617
end
17-
function render_item(::BeforeAfterImage, item)
18+
function render_item(io::IO, ::BeforeAfterImage, item::AbstractMatrix)
19+
# FIXME: encodeimg only support 2d cases right now
1820
str_item = @withcolor ImageInTerminal.encodeimg(ImageInTerminal.SmallBlocks(), ImageInTerminal.TermColor256(), item, 20, 40)[1]
19-
println("eltype: ", eltype(item))
20-
println("size: ", map(length, axes(item)))
21-
println("thumbnail:")
22-
println.(str_item)
21+
println(io, "eltype: ", eltype(item))
22+
println(io, "size: ", map(length, axes(item)))
23+
println(io, "thumbnail:")
24+
foreach(x->println(io, x), str_item)
2325
end
2426

2527
## 2 arg form render for comparing
26-
function render(mode::BeforeAfter, reference, actual)
27-
println("- REFERENCE -------------------")
28-
render_item(mode, reference)
29-
println("-------------------------------")
30-
println("- ACTUAL ----------------------")
31-
render_item(mode, actual)
32-
println("-------------------------------")
28+
render(mode::RenderMode, args...) = render(stdout, mode, args...)
29+
function render(io::IO, mode::BeforeAfter, reference, actual)
30+
println(io, "- REFERENCE -------------------")
31+
render_item(io, mode, reference)
32+
println(io, "-------------------------------")
33+
println(io, "- ACTUAL ----------------------")
34+
render_item(io, mode, actual)
35+
println(io, "-------------------------------")
3336
end
34-
function render(::Diff, reference, actual)
35-
println("- DIFF ------------------------")
36-
@withcolor println(deepdiff(reference, actual))
37-
println("-------------------------------")
37+
function render(io::IO, ::Diff, reference, actual)
38+
println(io, "- DIFF ------------------------")
39+
@withcolor println(io, deepdiff(reference, actual))
40+
println(io, "-------------------------------")
3841
end
3942

4043
## 1 arg form render for new content
41-
function render(mode::RenderMode, actual)
42-
println("- NEW CONTENT -----------------")
43-
render_item(mode, actual)
44-
println("-------------------------------")
44+
function render(io::IO, mode::RenderMode, actual)
45+
println(io, "- NEW CONTENT -----------------")
46+
render_item(io, mode, actual)
47+
println(io, "-------------------------------")
4548
end
4649

50+
# We set the fallback as limited mode because it is not safe/efficient to fully render anything unless
51+
# * we have prior information that it is not long -- numbers
52+
# * or, we know how to fully render it efficiently without sending too much noise to IO
53+
# - Diff mode for strings
54+
# - BeforeAfterImage for images
55+
# Arrays, in general, should be rendered using limited mode.
4756
"""
48-
default_rendermode(::DataFormat, actual)
57+
default_rendermode(actual)
4958
50-
Infer the most appropriate render mode according to type of reference file and `actual`.
59+
Infer the most appropriate render mode according to type of `actual`.
5160
"""
52-
default_rendermode(::Type{<:DataFormat}, ::Any) = BeforeAfterLimited()
53-
default_rendermode(::Type{<:DataFormat}, ::AbstractString) = Diff()
54-
default_rendermode(::Type{<:DataFormat}, ::AbstractArray{<:Colorant}) = BeforeAfterImage()
55-
56-
# plain TXTs
57-
default_rendermode(::Type{DataFormat{:TXT}}, ::Any) = Diff()
58-
default_rendermode(::Type{DataFormat{:TXT}}, ::AbstractString) = Diff()
59-
default_rendermode(::Type{DataFormat{:TXT}}, ::Number) = BeforeAfterFull()
60-
default_rendermode(::Type{DataFormat{:TXT}}, ::AbstractArray{<:Colorant}) = BeforeAfterImage()
61-
62-
# SHA256
63-
default_rendermode(::Type{DataFormat{:SHA256}}, ::Any) = BeforeAfterFull()
64-
default_rendermode(::Type{DataFormat{:SHA256}}, ::AbstractString) = BeforeAfterFull()
65-
default_rendermode(::Type{DataFormat{:SHA256}}, ::AbstractArray{<:Colorant}) = BeforeAfterLimited()
61+
default_rendermode(::Type) = BeforeAfterLimited()
62+
default_rendermode(::Type{T}) where T<:Number = BeforeAfterFull()
63+
default_rendermode(::Type{T}) where T<:AbstractString = Diff()
64+
default_rendermode(::Type{T}) where T<:AbstractArray{<:AbstractString} = Diff()
65+
default_rendermode(::Type{T}) where T<:AbstractArray{<:Colorant} = BeforeAfterImage()

‎src/test_reference.jl‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,7 @@ function test_reference(
103103
# infer the default rendermode here
104104
# since `nothing` is always passed to this method from
105105
# test_reference(filename::AbstractString, raw_actual; kw...)
106-
if rendermode === nothing
107-
rendermode = default_rendermode(F, raw_actual)
108-
end
106+
rendermode === nothing && (rendermode = default_rendermode(T))
109107

110108
actual = maybe_encode(F, raw_actual; kw...)
111109
# preprocessing when reference file doesn't exists

‎test/references/render/BeforeAfterFull/arr1_compare.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
- REFERENCE -------------------
2+
[1 3 5 7; 2 4 6 8]
3+
-------------------------------
4+
- ACTUAL ----------------------
5+
[1 2 3 4 5 6 7 8]
6+
-------------------------------

‎test/references/render/BeforeAfterFull/arr1_new.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- NEW CONTENT -----------------
2+
[1 2 3 4 5 6 7 8]
3+
-------------------------------

‎test/references/render/BeforeAfterFull/arr2_compare.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
- REFERENCE -------------------
2+
[1, 3, 5, 7, 9, 11, 13, 15, 17, 19]
3+
-------------------------------
4+
- ACTUAL ----------------------
5+
[1, 4, 7, 10, 13, 16, 19]
6+
-------------------------------

‎test/references/render/BeforeAfterFull/arr2_new.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- NEW CONTENT -----------------
2+
[1, 4, 7, 10, 13, 16, 19]
3+
-------------------------------

‎test/references/render/BeforeAfterFull/arr3_compare.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
- REFERENCE -------------------
2+
[1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0]
3+
-------------------------------
4+
- ACTUAL ----------------------
5+
[1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0]
6+
-------------------------------

‎test/references/render/BeforeAfterFull/arr3_new.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- NEW CONTENT -----------------
2+
[1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0; 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0]
3+
-------------------------------

‎test/references/render/BeforeAfterFull/dataframe1_compare.txt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
- REFERENCE -------------------
2+
3×2 DataFrame
3+
│ Row │ v1 │ v2 │
4+
│ │ Int64 │ String │
5+
├─────┼───────┼────────┤
6+
│ 1 │ 1 │ a │
7+
│ 2 │ 2 │ b │
8+
│ 3 │ 3 │ c │
9+
-------------------------------
10+
- ACTUAL ----------------------
11+
3×2 DataFrame
12+
│ Row │ v2 │ v1 │
13+
│ │ Int64 │ String │
14+
├─────┼───────┼────────┤
15+
│ 1 │ 1 │ a │
16+
│ 2 │ 2 │ b │
17+
│ 3 │ 3 │ c │
18+
-------------------------------

‎test/references/render/BeforeAfterFull/dataframe1_new.txt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
- NEW CONTENT -----------------
2+
3×2 DataFrame
3+
│ Row │ v2 │ v1 │
4+
│ │ Int64 │ String │
5+
├─────┼───────┼────────┤
6+
│ 1 │ 1 │ a │
7+
│ 2 │ 2 │ b │
8+
│ 3 │ 3 │ c │
9+
-------------------------------

0 commit comments

Comments
 (0)