More tests and some fixes (#5)

* add BenchmarkTools' license

* add some tests, tweak wording

* test empty benchmark case

Author: ericphanson

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Eric Hanson <[email protected]> and contributors
+Copyright (c) 2021 Eric P. Hanson and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,27 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+The file `src/vendor.jl` contains code taken from BenchmarkTools.jl, which
+is available under the following MIT license:
+
+> Copyright (c) 2015: Jarrett Revels.
+>
+> Permission is hereby granted, free of charge, to any person obtaining
+> a copy of this software and associated documentation files (the
+> "Software"), to deal in the Software without restriction, including
+> without limitation the rights to use, copy, modify, merge, publish,
+> distribute, sublicense, and/or sell copies of the Software, and to
+> permit persons to whom the Software is furnished to do so, subject to
+> the following conditions:
+>
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+> IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+> CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+> TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+> SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -7,11 +7,15 @@ Wraps [BenchmarkTools.jl](https://github.com/JuliaCI/BenchmarkTools.jl/) to prov
 
 This means one should not call `using` on both BenchmarkHistograms and BenchmarkTools in the same namespace, or else these `@benchmark` macros will conflict ("WARNING: using `BenchmarkTools.@benchmark` in module Main conflicts with an existing identifier.")
 
-However, BenchmarkHistograms re-exports all the export of BenchmarkTools, so you can simply call `using BenchmarkHistograms`.
+However, BenchmarkHistograms re-exports all of BenchmarkTools (including the module `BenchmarkTools` itself), so you can simply call `using BenchmarkHistograms` instead.
 
 Providing this functionality in BenchmarkTools itself was discussed in <https://github.com/JuliaCI/BenchmarkTools.jl/pull/180>.
 
-Use the setting `BenchmarkHistograms.NBINS[] = 10` to change the number of histogram bins used.
+Use the setting `BenchmarkHistograms.NBINS[]` to change the number of histogram bins used, e.g.
+```julia
+BenchmarkHistograms.NBINS[] = 10
+```
+to use 10 bins.
 
 ## Example
 

src/BenchmarkHistograms.jl

@@ -29,7 +29,7 @@ struct BenchmarkHistogram
 end
 
 # borrowed some from `show` implementation for `BenchmarkTools.Trial`
-function Base.show(io::IO, ::MIME"text/plain", bp::BenchmarkHistogram)
+function Base.show(io::IO, ::MIME"text/plain", bp::BenchmarkHistogram; nbins=NBINS[])
     t = bp.trial
     if length(t) > 0
         min = minimum(t)
@@ -51,10 +51,11 @@ function Base.show(io::IO, ::MIME"text/plain", bp::BenchmarkHistogram)
         meanstr = "N/A"
     end
     println(io, "samples: ", length(t), "; evals/sample: ", t.params.evals, "; memory estimate: ", memorystr, "; allocs estimate: ", allocsstr)
-
-    bin_arg = NBINS[] <= 0 ? NamedTuple() : (; nbins=NBINS[])
-    show(io, histogram(t.times; ylabel="ns", xlabel="Counts", bin_arg...))
-    println(io)
+    if length(t) > 0
+        bin_arg = nbins <= 0 ? NamedTuple() : (; nbins=nbins)
+        show(io, histogram(t.times; ylabel="ns", xlabel="Counts", bin_arg...))
+        println(io)
+    end
     print(io, "min: ", minstr, "; mean: ", meanstr, "; median: ", medstr, "; max: ", maxstr, ".")
 end
 

test/runtests.jl

@@ -1,7 +1,9 @@
 using BenchmarkHistograms
 using Test
+import BenchmarkTools
 
-function tests()
+
+function counting_tests(nbins=nothing)
     bp = @benchmark 1+1
     output = sprint(show, MIME"text/plain"(), bp)
 
@@ -26,19 +28,52 @@ function tests()
     return nothing
 end
 
-function tests(nbins)
+
+function empty_test()
+    bp = @benchmark 1+1
+    empty!(bp.trial.times)
+    output = sprint(show, MIME"text/plain"(), bp)
+
+    # Don't want to test the exact string since the stats will
+    # fluctuate. So let's just test that it contains the right
+    # number of the right things, and assume they're arranged properly.
+    n_matches = r -> length(collect(eachmatch(r, output)))
+
+    @test n_matches(r"samples:") == 1
+    @test n_matches(r"evals/sample:") == 1
+    @test n_matches(r"memory estimate:") == 1
+    @test n_matches(r"allocs estimate:") == 1
+    @test n_matches(r"ns") == 0
+    @test n_matches(r"Counts") == 0
+    @test n_matches(r"min") == n_matches(r"mean") == n_matches(r"median") == n_matches(r"max") == 1
+    @test n_matches(r"% GC") == 0
+    @test n_matches(r"┌") == n_matches(r"┐") == n_matches(r"└") == n_matches(r"┘") == 0
+    return nothing
+end
+
+function with_bins(f, nbins)
     pre = BenchmarkHistograms.NBINS[]
     BenchmarkHistograms.NBINS[] = nbins
     try
-        tests()
+        f(nbins)
     finally
         BenchmarkHistograms.NBINS[] = pre
     end
     return nothing
 end
 
 @testset "BenchmarkHistograms.jl" begin
-    tests()
-    tests(10)
-    tests(-1)
+
+    @testset "Exports" begin
+        @test symdiff(names(BenchmarkTools), names(BenchmarkHistograms)) == [:BenchmarkHistograms]
+    end
+
+    @testset "Counting tests" begin
+        counting_tests()
+        with_bins(counting_tests, 10)
+        with_bins(counting_tests, -1)
+        empty_test()
+    end
 end
+
+include("vendor.jl")

test/vendor.jl

@@ -0,0 +1,19 @@
+# taken from <https://github.com/JuliaCI/BenchmarkTools.jl/blob/e058ff249215671c196f2c24a0a3f401de27b718/test/TrialsTests.jl#L177-L199>
+
+@testset "Pretty printing" begin
+    @test BenchmarkHistograms.prettypercent(.3120123) == "31.20%"
+
+    @test BenchmarkHistograms.prettytime(999) == "999.000 ns"
+    @test BenchmarkHistograms.prettytime(1000) == "1.000 μs"
+    @test BenchmarkHistograms.prettytime(999_999) == "999.999 μs"
+    @test BenchmarkHistograms.prettytime(1_000_000) == "1.000 ms"
+    @test BenchmarkHistograms.prettytime(999_999_999) == "1000.000 ms"
+    @test BenchmarkHistograms.prettytime(1_000_000_000) == "1.000 s"
+
+    @test BenchmarkHistograms.prettymemory(1023) == "1023 bytes"
+    @test BenchmarkHistograms.prettymemory(1024) == "1.00 KiB"
+    @test BenchmarkHistograms.prettymemory(1048575) == "1024.00 KiB"
+    @test BenchmarkHistograms.prettymemory(1048576) == "1.00 MiB"
+    @test BenchmarkHistograms.prettymemory(1073741823) == "1024.00 MiB"
+    @test BenchmarkHistograms.prettymemory(1073741824) == "1.00 GiB"
+end