Skip to content

Document the skip keyword argument of @testitem #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davidanthoff merged 1 commit into from
Aug 13, 2026
Merged

Document the skip keyword argument of @testitem #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/TestItems.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ to share setup code between test items.
before running the test code. Defaults to `true`.
- `setup::Vector{Symbol}`: Names of `@testmodule` or `@testsnippet` definitions to
evaluate before the test item runs.
- `skip`: Either a `Bool` literal, or an arbitrary expression that evaluates to a `Bool`.
When it is `true` the test item is not run and is reported as skipped. Defaults to
`false`. An expression is evaluated **in the test process**, immediately before the
test item would have run, so checks like `VERSION < v"1.11"` or `Sys.iswindows()` see
the environment of the process the tests actually run in, not the one that discovered
them.

## Examples

Expand All @@ -38,6 +44,14 @@ end
db = DatabaseHelper.connect()
@test isopen(db)
end

@testitem "not ready yet" skip=true begin
@test false
end

@testitem "needs a recent Julia" skip=(VERSION < v"1.11") begin
@test true
end
```
"""
macro testitem(ex...)
Expand Down
Loading