tools.test_runner

A module to run openfisca yaml tests

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

Generates a lazy iterator of all the YAML tests contained in a file or a directory.

Parameters:Same as run_tests()
Returns:a generator of YAML tests
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 ((str/list)) – 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 (dict) – See more details below.
Raises:

AssertionError – if a test does not pass

Returns:

the number of sucessful tests excecuted

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.