Merge branch 'master' into updated_ci_url

ssfrr · web-flow · commit fd4b80cc4bd9 · 2017-05-28T22:09:22.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 *.jl.cov
 *.jl.*.cov
 *.jl.mem
+coverage
diff --git a/.travis.yml b/.travis.yml
@@ -4,8 +4,7 @@ os:
   - linux
   - osx
 julia:
-  - 0.4
-  - 0.5
+  - 0.6
 notifications:
   email: false
 # uncomment the following lines to override the default test script
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,4 +1,4 @@
-The DottedTestSets.jl package is licensed under the MIT "Expat" License:
+The TestSetExtensions.jl package is licensed under the MIT "Expat" License:
 
 > Copyright (c) 2016: Spencer Russell.
 >
diff --git a/README.md b/README.md
@@ -4,19 +4,19 @@
 [![Build status](https://ci.appveyor.com/api/projects/status/79m2ru7o3upt86ds/branch/master?svg=true)](https://ci.appveyor.com/project/ssfrr/testsetextensions-jl/branch/master)
 [![codecov.io](http://codecov.io/github/ssfrr/TestSetExtensions.jl/coverage.svg?branch=master)](http://codecov.io/github/ssfrr/TestSetExtensions.jl?branch=master)
 
-![TestSetExtensions example gif](http://ssfrr.github.io/TestSetExtensions.jl/DottedTestSet.gif)
+![TestSetExtensions example gif](http://ssfrr.github.io/TestSetExtensions.jl/ExtendedTestSet.gif)
 
 This package collects some extensions and convenience utilities to maximize your testing enjoyment. It builds on the new `Base.Test` infrastructure in Julia v0.5 (also available in v0.4 with the `BaseTestNext` package). It's designed so that you shouldn't need to modify your tests at all if you're already using `@testset` and `@test` - all the interactions with this package happen at the top-level of your tests.
 
-## `DottedTestSet`
+## `ExtendedTestSet`
 
-This is a simple TestSet type that outputs green dots as your tests pass, so you can have a sense of progress. To use it, simply add `DottedTestSet` as a custom testset type to your top-level `@testset`, and then use `Base.Test` as usual. All nested testsets will use it as well.
+The `ExtendedTestSet` type makes your test output more readable. It outputs green dots as your tests pass, so you can have a sense of progress. It also displays diffs on test failure using the [`DeepDiffs`](https://github.com/ssfrr/DeepDiffs.jl) package. To use it, simply add `ExtendedTestSet` as a custom testset type to your top-level `@testset`, and then use `Base.Test` functions as usual. All nested testsets will use it automatically.
 
 ```julia
 using Base.Test
 using TestSetExtensions
 
-@testset DottedTestSet "All the tests" begin
+@testset ExtendedTestSet "All the tests" begin
     @testset "2nd-level tests 1" begin
         @test true
         @test 1 == 1
@@ -28,6 +28,10 @@ using TestSetExtensions
 end
 ```
 
+### Diff output example
+
+![After diff output](http://ssfrr.github.io/TestSetExtensions.jl/diff_after.png)
+
 ## `@includetests`
 TestSetExtensions also provides a `@includetests` macro that makes it easy to selectively run your tests, for cases when your full test suite is large and you only need to run a subset of your tests to test a feature you're working on. The macro takes a list of test files, so you can pass it `ARGS` to allow the user to specify which tests to run from the command line.
 
@@ -48,6 +52,6 @@ $ julia test/runtests.jl footests bartests
 
 Which will run `footests.jl` and `bartests.jl`.
 
-`@includetests` will print out each test module name as it goes (here in combination with `DottedTestSet`):
+`@includetests` will print out each test module name as it goes (here in combination with `ExtendedTestSet`):
 
 ![includetests output](http://ssfrr.github.io/TestSetExtensions.jl/includetests.png)
diff --git a/REQUIRE b/REQUIRE
@@ -1,2 +1,2 @@
-julia 0.4
-BaseTestNext
+julia 0.6.0-pre
+DeepDiffs
diff --git a/appveyor.yml b/appveyor.yml
@@ -1,9 +1,7 @@
 environment:
   matrix:
-  - JULIA_URL: "https://julialang-s3.julialang.org/bin/winnt/x86/0.4/julia-0.4-latest-win32.exe"
-  - JULIA_URL: "https://julialang-s3.julialang.org/bin/winnt/x64/0.4/julia-0.4-latest-win64.exe"
-  - JULIA_URL: "https://julialang-s3.julialang.org/bin/winnt/x86/0.5/julia-0.5-latest-win32.exe"
-  - JULIA_URL: "https://julialang-s3.julialang.org/bin/winnt/x64/0.5/julia-0.5-latest-win64.exe"
+  - JULIA_URL: "https://julialang-s3.julialang.org/bin/winnt/x86/0.6/julia-0.6-latest-win32.exe"
+  - JULIA_URL: "https://julialang-s3.julialang.org/bin/winnt/x64/0.6/julia-0.6-latest-win64.exe"
 
 notifications:
   - provider: Email
diff --git a/diffdemo.jl b/diffdemo.jl
@@ -0,0 +1,20 @@
+using Base.Test
+using TestSetExtensions
+
+@testset ExtendedTestSet "Nice Diffs" begin
+    @test [3, 5, 6, 1, 6, 8] == [3, 5, 6, 1, 9, 8]
+    @test """Lorem ipsum dolor sit amet,
+             consectetur adipiscing elit, sed do
+             eiusmod tempor incididunt ut
+             labore et dolore magna aliqua.
+             Ut enim ad minim veniam, quis nostrud
+             exercitation ullamco aboris.""" ==
+          """Lorem ipsum dolor sit amet,
+             consectetur adipiscing elit, sed do
+             eiusmod temper incididunt ut
+             labore et dolore magna aliqua.
+             Ut enim ad minim veniam, quis nostrud
+             exercitation ullamco aboris."""
+    @test Dict(:foo => "bar", :baz => [1, 4, 5], :biz => nothing) ==
+          Dict(:baz => [1, 7, 5], :biz => 42)
+end
diff --git a/runtests.sh b/runtests.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+
+# Runs the SampledSignals tests including generating an lcov.info file
+
+# abort on failure
+set -e
+
+julia -e 'using Coverage; clean_folder(".");'
+julia --color=yes --inline=no --code-coverage=user test/runtests.jl
+mkdir -p coverage
+julia -e 'using Coverage; res=process_folder(); LCOV.writefile("coverage/lcov.info", res)'
diff --git a/src/TestSetExtensions.jl b/src/TestSetExtensions.jl
@@ -1,16 +1,17 @@
 module TestSetExtensions
 
-export DottedTestSet, @includetests
-
-if VERSION >= v"0.5.0-dev+7720"
-    using Base.Test
-    import Base.Test: record, finish
-    using Base.Test: DefaultTestSet, AbstractTestSet, Pass, get_testset_depth
-else
-    using BaseTestNext
-    import BaseTestNext: record, finish
-    using BaseTestNext: DefaultTestSet, AbstractTestSet, Pass, get_testset_depth
-end
+export ExtendedTestSet, @includetests
+
+using Base.Test
+import Base.Test: record, finish
+using Base.Test: DefaultTestSet, AbstractTestSet
+using Base.Test: get_testset_depth, scrub_backtrace
+using Base.Test: Result, Pass, Fail, Error
+
+using Base: @deprecate
+@deprecate DottedTestSet ExtendedTestSet
+
+using DeepDiffs
 
 """
 Includes the given test files, given as a list without their ".jl" extensions.
@@ -44,25 +45,65 @@ macro includetests(testarg...)
     end
 end
 
-type DottedTestSet{T<:AbstractTestSet} <: AbstractTestSet
+struct ExtendedTestSet{T<:AbstractTestSet} <: AbstractTestSet
     wrapped::T
 
-    DottedTestSet(desc) = new(T(desc))
+    ExtendedTestSet{T}(desc) where {T} = new(T(desc))
+end
+
+struct FailDiff <: Result
+    result::Fail
+end
+
+function ExtendedTestSet(desc; wrap=DefaultTestSet)
+    ExtendedTestSet{wrap}(desc)
 end
 
-function DottedTestSet(desc; wrap=DefaultTestSet)
-    DottedTestSet{wrap}(desc)
+function record(ts::ExtendedTestSet, res::Fail)
+    if myid() == 1
+        println("\n=====================================================")
+        print_with_color(:white, ts.wrapped.description, ": ")
+        if res.test_type == :test && isa(res.data,Expr) && res.data.head == :comparison
+            dd = deepdiff(res.data.args[1], res.data.args[3])
+            if !isa(dd, DeepDiffs.SimpleDiff)
+                # The test was an comparison between things we can diff,
+                # so display the diff
+                print_with_color(Base.error_color(), "Test Failed\n"; bold = true)
+                println("  Expression: ", res.orig_expr)
+                print_with_color(Base.info_color(), "\nDiff:\n")
+                display(dd)
+                println()
+            else
+                # fallback to the default printing if we don't have a pretty diff
+                print(res)
+            end
+        else
+            # fallback to the default printing for non-comparisons
+            print(res)
+        end
+        Base.show_backtrace(STDOUT, scrub_backtrace(backtrace()))
+        # show_backtrace doesn't print a trailing newline
+        println("\n=====================================================")
+    end
+    push!(ts.wrapped.results, res)
+    res, backtrace()
+end
+
+function record(ts::ExtendedTestSet, res::Error)
+    println("\n=====================================================")
+    record(ts.wrapped, res)
+    print("=====================================================\n")
 end
 
-function record(ts::DottedTestSet, res::Pass)
+function record(ts::ExtendedTestSet, res::Pass)
     print_with_color(:green, ".")
     record(ts.wrapped, res)
     res
 end
 
-record(ts::DottedTestSet, res) = record(ts.wrapped, res)
+record(ts::ExtendedTestSet, res) = record(ts.wrapped, res)
 
-function finish(ts::DottedTestSet)
+function finish(ts::ExtendedTestSet)
     get_testset_depth() == 0 && print("\n\n")
     finish(ts.wrapped)
 end
diff --git a/test/runtests.jl b/test/runtests.jl
@@ -1,17 +1,13 @@
 using TestSetExtensions
 using Suppressor
 
-if VERSION >= v"0.5.0-dev+7720"
-    using Base.Test
-else
-    using BaseTestNext
-end
+using Base.Test
 
 orig_color = Base.have_color
 
 eval(Base, :(have_color = true))
 output_color = @capture_out begin
-    @testset DottedTestSet "top-level tests" begin
+    @testset ExtendedTestSet "top-level tests" begin
         @testset "2nd-level tests 1" begin
             @test true
             @test 1 == 1
@@ -25,7 +21,7 @@ end
 
 eval(Base, :(have_color = false))
 output_nocolor = @capture_out begin
-    @testset DottedTestSet "top-level tests" begin
+    @testset ExtendedTestSet "top-level tests" begin
         @testset "2nd-level tests 1" begin
             @test true
             @test 1 == 1
@@ -39,7 +35,32 @@ end
 
 eval(Base, :(have_color = $orig_color))
 
-@testset DottedTestSet "TextSetExtensions Tests" begin
+
+try
+    info("You should see 3 failing tests with pretty diffs...")
+    include(joinpath("..", "diffdemo.jl"))
+catch
+end
+try
+    info("These 4 failing tests don't have pretty diffs to display")
+    @testset ExtendedTestSet "not-pretty" begin
+        @testset "No pretty diff for matrices" begin
+            @test [1 2; 3 4] == [1 4; 3 4]
+        end
+        @testset "don't diff non-equality" begin
+            @test 1 > 2
+        end
+        @testset "don't diff non-comparisons" begin
+            @test iseven(7)
+        end
+        @testset "errors don't have diffs either" begin
+            throw(ErrorException("This test is supposed to throw an error"))
+        end
+    end
+catch
+end
+
+@testset ExtendedTestSet "TextSetExtensions Tests" begin
     @testset "check output" begin
         if VERSION <= v"0.6.0-"
             @test split(output_color, '\n')[1] == "\e[1m\e[32m.\e[0m\e[1m\e[32m.\e[0m\e[1m\e[32m.\e[0m\e[1m\e[32m.\e[0m"
@@ -49,6 +70,14 @@ eval(Base, :(have_color = $orig_color))
         @test split(output_nocolor, '\n')[1] == "...."
     end
 
+
+    @testset "DottedTestSet is deprecated" begin
+        @test_warn "DottedTestSet is deprecated, use ExtendedTestSet instead." @testset DottedTestSet "testing" begin
+            @test true
+        end
+    end
+
+
     @testset "Auto-run test files" begin
         global file1_run = false
         global file2_run = false

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-The DottedTestSets.jl package is licensed under the MIT "Expat" License:`
	`1`	`+The TestSetExtensions.jl package is licensed under the MIT "Expat" License:`
`2`	`2`
`3`	`3`	`> Copyright (c) 2016: Spencer Russell.`
`4`	`4`	`>`