ParallelTestRunner.jl

https://juliatesting.github.io/ParallelTestRunner.jl/stable/
Admin
ParallelTestRunner.jl is a parallel test runner for Julia that provides automatic test discovery and...
Tokens:2,035
Snippets:20
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example output from running tests with ParallelTestRunner

Source: https://juliatesting.github.io/ParallelTestRunner.jl

Sample output showing parallel test execution with two jobs, including per-test timing and memory statistics, and a final summary with pass count and total time.

```text
Running 2 tests using 2 parallel jobs. To change the number of jobs, specify the `--jobs=N` argument to the tests, or set the `PTR_NUM_JOBS` environment variable.
               │   Test   │ ──────────────── CPU ──────────────── │
Test  (Worker) │ time (s) │ GC (s) │ GC % │ Alloc (MB) │ RSS (MB) │
basic     (17) │     0.11 │   0.00 │  0.0 │       2.47 │   829.71 │
advanced  (16) │     0.10 │   0.00 │  0.0 │       2.47 │   829.71 │

Test Summary: | Pass  Total  Time
  Overall     |    2      2  2.4s
    SUCCESS
```

--------------------------------

### runtests.jl usage examples

Source: https://juliatesting.github.io/ParallelTestRunner.jl

Examples of common invocations: listing tests, filtering by name, setting verbosity and job count, and enabling quick-fail behavior.

```bash
# List all available tests
julia --project test/runtests.jl --list

# Run only tests matching "integration"
julia --project test/runtests.jl integration

# Run with verbose output and 4 workers
julia --project test/runtests.jl --verbose --jobs=4

# Run with quick-fail enabled
julia --project test/runtests.jl --quickfail
```

--------------------------------

### Basic runtests.jl command syntax

Source: https://juliatesting.github.io/ParallelTestRunner.jl

Shows the general command line syntax for running tests with the runtests.jl script. Options and test filters can be passed after the script path.

```bash
julia --project test/runtests.jl [OPTIONS] [TESTS...]
```

--------------------------------

### Run tests from the command line

Source: https://juliatesting.github.io/ParallelTestRunner.jl

Use this command to run tests via the standard Julia package testing interface. It executes Pkg.test on the specified package.

```bash
julia --project -e 'using Pkg; Pkg.test("MyPackage")'
```

--------------------------------

### Passing arguments through Pkg.test

Source: https://juliatesting.github.io/ParallelTestRunner.jl

Shows how to pass command line arguments to runtests.jl via Pkg.test using the test_args keyword.

```julia
using Pkg
Pkg.test("MyPackage"; test_args=`--verbose --jobs=4 integration`)
```

--------------------------------

### Standard Julia test file structure using Test standard library

Source: https://juliatesting.github.io/ParallelTestRunner.jl

Test files should be standard Julia test files using the Test standard library. Each test file runs in its own isolated module, so test pollution between files is not a concern.

```julia
using Test
using MyPackage

@testset "MyPackage tests" begin
    @test 1 + 1 == 2
    @test MyPackage.my_function(42) == 84
end
```

--------------------------------

### Run tests from within Julia

Source: https://juliatesting.github.io/ParallelTestRunner.jl

Use this code to run tests from an interactive Julia session or a script. It calls Pkg.test on the specified package.

```julia
using Pkg
Pkg.test("MyPackage")
```

--------------------------------

### Update test/runtests.jl to use ParallelTestRunner

Source: https://juliatesting.github.io/ParallelTestRunner.jl

Replace the contents of test/runtests.jl with this code to enable automatic test discovery and parallel execution. Remove existing include statements from test files first.

```julia
using MyPackage
using ParallelTestRunner

runtests(MyPackage, ARGS)
```
Tokens:
Raw