tools.test_runner

class openfisca_core.tools.test_runner.ErrorMargin(__root__)[source]
class openfisca_core.tools.test_runner.Options(_typename, _fields=None, /, **kwargs)[source]
class openfisca_core.tools.test_runner.Test(absolute_error_margin, relative_error_margin, name='', input=<factory>, output=None, period=None, reforms=<factory>, keywords=None, extensions=<factory>, description=None, max_spiral_loops=None)[source]
class openfisca_core.tools.test_runner.YamlFile(*k, **kw)[source]
collect()[source]

returns a list of children (items and collectors) for this collection node.

class openfisca_core.tools.test_runner.YamlItem(*k, **kw)[source]

Terminal nodes of the test collection tree.

openfisca_core.tools.test_runner.run_tests(tax_benefit_system, paths, options={})[source]

Runs all the YAML tests contained in a file or a directory.

If path is a directory, subdirectories will be recursively explored.

Parameters
  • tax_benefit_system (TaxBenefitSystem) – the tax-benefit system to use to run the tests.

  • paths (Union[str, Sequence[str]]) – A path, or a list of paths, towards the files or directories containing the tests to run. If a path is a directory, subdirectories will be recursively explored.

  • options (Options) – See more details below.

Return type

int

Returns

The number of successful tests executed.

Raises

AssertionError – if a test does not pass.

Testing options:

Key

Type

Role

verbose

bool

See openfisca test options doc

name_filter

str

Tests can also be run in the console with openfisca test.