Configuring tests¶
Hegel’s behaviour is controlled by settings: how many test cases to run, how much to print, where to keep the example database, and more. This page covers the settings you’re most likely to change and the ways to change them. Settings describes every setting and exactly how the different ways of setting them combine.
Settings for one test¶
Pass settings as keyword arguments to @hegel.test. The most common one is
test_cases, the number of test cases to run, which defaults to 100:
@hegel.test(test_cases=500)
def test_integers_many(tc):
n = tc.draw(gs.integers())
assert n == n
Settings can also be collected in a hegel.Settings object and passed
as settings=, which lets several tests share them:
thorough = hegel.Settings(test_cases=1000, report_multiple_failures=True)
@hegel.test(settings=thorough)
def test_one(tc): ...
@hegel.test(settings=thorough, verbosity="verbose")
def test_two(tc): ...
Keyword arguments given alongside settings= override its fields. A setting
whose value is an enum, like verbosity, takes either the enum member
(hegel.Verbosity.verbose) or its name ("verbose").
Some settings you may want:
test_casesHow many test cases to run.
verbosity"quiet","normal","verbose"(print every test case as it runs) or"debug"(also each failing test case’s traceback).seedA fixed seed, to make a run repeatable.
derandomize=Trueinstead derives the seed from the test’s name, so every run of a test is the same.databaseThe directory for the example database, or
""to turn it off.suppress_health_checkHealth checks to turn off; see Suppress a health check.
show_statisticsPrint statistics about what the test generated; see See what your test generates.
Changing settings without editing tests¶
Settings written in the test always apply. Everything else comes from a settings profile, a named collection of settings that applies to every test in a run. Hegel ships with three, and picks one for you:
developmentHegel’s default settings, used when running locally.
ciUsed automatically on a CI server. It derandomizes every test, so CI runs are repeatable, turns off the example database, and suppresses the
too_slowhealth check.workloadUsed automatically inside Antithesis.
You can modify these or add your own in a hegel.toml file at the root of
your project:
[profiles.development]
test_cases = 200
[profiles.nightly]
test_cases = 10000
Select a profile for a run with pytest’s --hegel-profile option, or the
HEGEL_DEFAULT_PROFILE environment variable:
pytest --hegel-profile=nightly
HEGEL_DEFAULT_PROFILE=nightly pytest
A few settings also have environment variables of their own, which are the quickest way to adjust one run. For example:
HEGEL_TEST_CASES=10000 pytest
runs 10,000 test cases of every test that doesn’t set test_cases itself.
Settings lists all of them, and
pytest integration lists the pytest options.
You can also define profiles in Python, with
Settings.register_profile, and
choose one with
Settings.set_default_profile,
for example in a conftest.py:
import hegel
hegel.Settings.register_profile("thorough", test_cases=10_000)
hegel.Settings.set_default_profile("thorough")