dtf – Primary User Interface

Module

Constants

dtf.VERBOSE

Boolean. False by default. When True, dtf will silence output from passing tests.

See dtf --verbose

dtf.FATAL

Boolean. False by default. When True, dtf will raise an exception and halt operation when a test fails, rather than continuing.

dtf.PASSING

Boolean. False by default. When True, if a case provides support, dtf will return a passing test specification for any failed test.

dtf.MULTI

String. None by default. Controls the parallelism model used by dtf. Valid possibilities are:

  • thread - run tests using thread pool. May provide better performance for suites that are I/O or computationally intensive (e.g. hashing.)
  • process - run tests using a multi-process worker pool. May provide better performance for suites with more complex Python cases.
  • None - run tests sequentially, with no parallelism..
dtf.JOBS

Integer. 2 by default. The size of the worker pool used by the parallelism model defined by MULTI.

dtf.SINGLE

Boolean. False by default. When True dtf will run a single test rather than an entire suite. See run_one() for more information.

dtf.YAMLTEST

String. None by default. When SINGLE is true, the value of YAMLTEST specifies the location of the test specification.

dtf.CASEDEF

String. None by default. When SINGLE is true, the value of CASEDEF specifies the location of the case definition.

dtf.CASEDIR

String (i.e. file path.) In the default “suite” mode (i.e. when SINGLE is False,) this path points to the directory of cases (i.e. Python modules) that define test conditions.

dtf.TESTDIR

String (i.e. file path.) In the default “suite” mode (i.e. when SINGLE is False,) this path points to the directory of tests (i.e. YAML specifications) that specify each test.