runtests

run the test files in a specific directory and path.

Jive.runtests — Function

runtests(dir::String ;
         skip::Union{Vector{Any},Vector{String}} = String[],
         node1::Union{Vector{Any},Vector{String}} = [],
         targets::Vector{String} = ARGS,
         enable_distributed::Bool = true,
         stop_on_failure::Bool = false,
         context::Union{Nothing,Module} = nothing,
         verbose::Bool = true)

run the test files from the specific directory.

dir: the root directory to traverse.
skip: files or directories to skip.
node1: run on node 1 during for the distributed tests.
targets: filter targets and start. default is ARGS.
enable_distributed: option for distributed.
stop_on_failure: stop on the failure or error.
context: module that to be used in Base.include. nothing means to be safe that using anonymous module for every test file.
verbose: print details of test execution

source

suppose you have some test files in the test/ directory for your package. now let's make your test/runtests.jl with

using Jive
runtests(@__DIR__)

for the runtests.jl, ARGS are used to filter the targets and to set the start offset of the tests.

~/.julia/dev/Jive/test $ julia runtests.jl jive/s start=3
1/4 jive/skip/skip-calls.jl --
2/4 jive/skip/skip-exprs.jl --
3/4 jive/skip/skip-functions.jl
    Pass 4  (0.40 seconds)
4/4 jive/skip/skip-modules.jl
    Pass 4  (0.01 seconds)
✅  All 8 tests have been completed.  (0.62 seconds)

in the above example, test files are matched for only have jive/s and jumping up to the 3rd file.

Examples

run tests

~/.julia/dev/Jive/test $ julia runtests.jl

run tests with target directory.

~/.julia/dev/Jive/test $ julia runtests.jl jive/If

distributed run tests with -p

~/.julia/dev/Jive/test $ julia -p3 runtests.jl

distributed run tests for Pkg.test(), using JIVE_PROCS ENV.

~/.julia/dev/Jive $ JIVE_PROCS=2 julia --project=. -e 'using Pkg; Pkg.test()'

~/.julia/dev/Jive $ julia --project=. -e 'ENV["JIVE_PROCS"]="2"; using Pkg; Pkg.test()'

TestJive.jl is an example package for using Jive. look at also the Project.toml file for your own package.

[extras]
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
Jive = "ba5e3d4b-8524-549f-bc71-e76ad9e9deed"

[targets]
test = ["Test", "Jive"]

Watch package folders

You may need to install Revise.jl.

~/.julia/dev/Jive/test/Example/test $ cat runtests.jl
using Jive
runtests(@__DIR__, skip=["revise.jl"])

~/.julia/dev/Jive/test/Example/test $ cat revise.jl
# julia -i -q --project=.. revise.jl example

using Revise, Jive
using Example

trigger = function (path)
    printstyled("changed ", color=:cyan)
    println(path)
    revise()
    runtests(@__DIR__, skip=["revise.jl"])
end

watch(trigger, @__DIR__, sources=[pathof(Example)])
trigger("")

Base.JLOptions().isinteractive==0 && wait()

~/.julia/dev/Jive/test/Example/test $ julia -i -q --project=.. revise.jl example
watching folders ...
  - ../src
  - example
changed
1/1 example/test1.jl
    Pass 1  (0.27 seconds)
✅  All 1 test has been completed.  (0.55 seconds)

when saving any files in the watching folders, it automatically run tests.