Skip to content

Commit 16bb0f6

Browse files
Recommend using TestPicker.jl in docs (#2403)
* recommend using TestPicker.jl * add new paragraph --------- Co-authored-by: Hendrik Ranocha <[email protected]>
1 parent 0e56206 commit 16bb0f6

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/src/testing.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,23 @@ julia> # Run all 2D tests on the P4estMesh
4343
julia> # Run all 1D tests for the Euler equations on the TreeMesh
4444
include(joinpath("test", "test_tree_1d_euler.jl"))
4545
```
46+
Often you want to run only a specific test or a small subset of tests. To do this, we
47+
recommend using [TestPicker.jl](https://github.com/theogf/TestPicker.jl). To make
48+
TestPicker.jl aware of the special testing system used in Trixi.jl, you first need to
49+
[set the environment variable "TESTPICKER_NODES"](https://github.com/theogf/TestPicker.jl#running-other-test-blocks-than-testset):
50+
```julia
51+
julia> ENV["TESTPICKER_NODES"] = "@trixi_testset, @timed_testset"
52+
```
53+
To automatically set the environment variable, on Unix-like systems you can add
54+
```bash
55+
export TESTPICKER_NODES="@trixi_testset, @timed_testset"
56+
```
57+
to the `~/.bashrc` file. After `using TestPicker`, you can enter the REPL test mode
58+
with `!` and search for test files with a fuzzy search. To search for testsets, you
59+
can separate the fuzzy search for test files and a fuzzy search of testsets with
60+
a colon. For more details, check out the documentation of
61+
[TestPicker.jl](https://github.com/theogf/TestPicker.jl).
62+
4663
For the automated tests with GitHub Actions, we run multiple jobs in parallel to
4764
reduce the waiting time until all tests are finished. You can see the different
4865
components that are run as jobs by looking at the `TRIXI_TEST` variable in

0 commit comments

Comments
 (0)