Add the ability to pass a custom comparison function (#4)

The motivating case was a test where the output is path-dependent,
so the comparison function needs to compare against the test
machine's path.

Author: timholy

.gitignore

@@ -0,0 +1,2 @@
+test/expected.out
+test/failed.out

Project.toml

@@ -7,5 +7,11 @@ version = "0.1.2"
 REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
 VT100 = "7774df62-37c0-5c21-b34d-f6d7f98f54bc"
 
+[extras]
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
 [compat]
 julia = "1.1"
+
+[targets]
+test = ["Test"]

src/TerminalRegressionTests.jl

@@ -155,7 +155,7 @@ module TerminalRegressionTests
         end
     end
 
-    function automated_test(f, outputpath, inputs; aggressive_yield = false)
+    function automated_test(f, cmp, outputpath, inputs; aggressive_yield = false)
         emuterm = EmulatedTerminal()
         emuterm.aggressive_yield = aggressive_yield
         emuterm.terminal.warn = true
@@ -178,7 +178,7 @@ module TerminalRegressionTests
                 decorator = isempty(decorators) ? nothing : popfirst!(decorators)
                 @assert !eof(emuterm.pty.master)
                 process_all_buffered(emuterm)
-                compare(emuterm.terminal, output, decorator)
+                cmp(emuterm.terminal, output, decorator)
                 print(emuterm.input_buffer, input); notify(emuterm.filled)
             end
             Base.notify(c)
@@ -190,6 +190,7 @@ module TerminalRegressionTests
             wait(c)
         end
     end
+    automated_test(f, outputpath, inputs; kwargs...) = automated_test(f, compare, outputpath, inputs; kwargs...)
 
     function create_automated_test(f, outputpath, inputs; aggressive_yield=false)
         emuterm = EmulatedTerminal()

test/TRT2.multiout

@@ -0,0 +1,6 @@
+++++++++++++++++++++++++++++++++++++++++++++++++++
+|Hello, wurld!
+|
+--------------------------------------------------
+|AAAAAAAAAAAAA
+|

test/runtests.jl

@@ -1,4 +1,5 @@
 using TerminalRegressionTests
+using Test
 
 const thisdir = dirname(@__FILE__)
 TerminalRegressionTests.automated_test(
@@ -10,3 +11,35 @@ TerminalRegressionTests.automated_test(
     resp = strip(readline(emuterm))
     @assert resp == "Yes!!"
 end
+
+mktemp() do _, io
+    redirect_stderr(io) do
+        redirect_stdout(io) do
+            @test_throws ErrorException TerminalRegressionTests.automated_test(
+                            joinpath(thisdir,"TRT2.multiout"),
+                            [""]) do emuterm
+                println(emuterm, "Hello, world!")   # generate with "wurld" rather than "world"
+                readline(emuterm)   # needed to produce output?
+            end
+        end
+    end
+end
+
+function compare_replace(em, output; replace=nothing)
+    buf = IOBuffer()
+    decoratorbuf = IOBuffer()
+    TerminalRegressionTests.VT100.dump(buf,decoratorbuf,em)
+    outbuf = take!(buf)
+    if replace !== nothing
+        output = Base.replace(output, replace)
+    end
+    TerminalRegressionTests._compare(Vector{UInt8}(codeunits(output)), outbuf) || return false
+    return true
+end
+const cmp(a, b, decorator) = compare_replace(a, b; replace="wurld"=>"world")
+TerminalRegressionTests.automated_test(cmp,
+                joinpath(thisdir,"TRT2.multiout"),
+                [""]) do emuterm
+    println(emuterm, "Hello, world!")
+    readline(emuterm)
+end