Debug Output Configuration

The following Django settings allow configuration of the ExpandedTestCases package, regarding settings for package debug output on test failure.

All of these settings are optional, and will fall back to a default value if not defined.

Note

When doing a testing comparison of two values, all logic in ETC assumes the format of someAssert(<expected_value>, <actual_value>).

That is, the “expected” should always come first, and the “actual” should come later.

This ordering affects:

General assertion error messages. If ordering is wrong, then some error output might be slightly misleading. This is sometimes the case even in default Django test assertions.
Color debug output, if Colorama is installed.

General Debug Output Handling

General configurations for handling of debug output on test errors.

For many of these settings, they allow customizing to personal preference for readability. Thus, we recommend setting up a project .env file (or equivalent) so that these settings can be set per-developer, for whatever allows them the most optimal individual workflow.

DEBUG_PRINT

Django ETC can optionally provide additional debug testing output, to help with trying to troubleshoot test errors. See Debug Output Overview for more details.

This setting enables or disables debug output.

Type:: bool
Default:: True

Example:

DJANGO_EXPANDED_TESTCASES_DEBUG_PRINT = False

DEBUG_PRINT__SKIP_DISPLAY

A set of regex-matching strings to skip displaying during debug output. Since it’s regex, it can match arbitrary values in the middle of html.

Useful such as when importing third-party libraries with front-end elements, if you don’t expect to ever need to test for said elements.

Should be a list containing strings of one or more regex values to skip.

Type:: list
Default:: [],

Example:

DJANGO_EXPANDED_TESTCASES_DEBUG_PRINT__SKIP_DISPLAY = [
    'regex1',
    'regex2',
]

DEBUG_PRINT__TEST_SEPARATOR

Optionally customize the visual separator between UnitTest error output. This is displayed at the top of every failing UnitTest output, to help add visual distinction of where one test ends and the next begins.

Can be used to add extra newlines or other formatting to debugging output.

Note

Must manually insert newlines at the end of each line where desired. Can optionally also insert color formatting if desired.

Type:: str
Default:: ''

Example:

DJANGO_EXPANDED_TESTCASES_DEBUG_PRINT__TEST_SEPARATOR = (
    '\n'
    '\n'
    '=========================**********=========================\n'
    '=========================**********=========================\n'
    '\n'
    '\n'
)

DEBUG_PRINT__RESPONSE_SEPARATOR

Optionally customize the visual separator between Response Assertions. This is displayed at the bottom of the assertResponse debug output.

Can be used to add extra newlines or other formatting between assertResponse debugging output.

Note

Must manually insert newlines at the end of each line where desired. Can optionally also insert color formatting if desired.

Type:: str
Default:: ''

Example:

DJANGO_EXPANDED_TESTCASES_DEBUG_PRINT__RESPONSE_SEPARATOR = (
    '\n'
    '\n'
    '=========================**********=========================\n'
    '=========================**********=========================\n'
    '\n'
    '\n'
)

DEBUG_PRINT__STD_OUT_SEPARATOR

Optionally customize the visual separator at the end of test std_out (print) output, during debug output for a failing Response Assertion.

Aside adding visual separation in a separate location, handles generally the same as the above DEBUG_PRINT__RESPONSE_SEPARATOR.

Type:: str
Default:: ''

Example:

DJANGO_EXPANDED_TESTCASES_DEBUG_PRINT__STD_OUT_SEPARATOR = (
    '\n'
    '\n'
    '=========================**********=========================\n'
    '=========================**********=========================\n'
    '\n'
    '\n'
)

DEBUG_PRINT__LOGGING_SEPARATOR

Optionally customize the visual separator at the end of test logging output, during debug output for a failing Response Assertion.

Aside adding visual separation in a separate location, handles generally the same as the above DEBUG_PRINT__RESPONSE_SEPARATOR.

Type:: str
Default:: ''

Example:

DJANGO_EXPANDED_TESTCASES_DEBUG_PRINT__LOGGING_SEPARATOR = (
    '\n'
    '\n'
    '=========================**********=========================\n'
    '=========================**********=========================\n'
    '\n'
    '\n'
)

ASSERT_CONTENT__SURROUNDING_CHECK_OUTPUT_LENGTH

Controls how many “contextual values” are shown on assertContent test error.

This setting specifically only applies when the assertContent is given multiple values to test for in a single assertion.

The default value (of 2) shows the two statements before and the two after the failing value, if possible.

Then for example, setting to this to 3 will attempt to show 3 statements before and after. While setting this to 0 will skip the assertion trying to output context on failure.

Type:: int
Default:: 2

Example:

DJANGO_EXPANDED_TESTCASES_ASSERT_CONTENT__SURROUNDING_CHECK_OUTPUT_LENGTH = 3

Showing/Hiding Output Regions

On a UnitTest response failure, ETC will attempt to display debug output for any requests that were triggered prior to the failure, when using Response Assertion.

This output can provide quite a bit of information.

In some projects, this is helpful. In others, it ends up being overkill with some of it turning into white noise.

To help account for both ends of this spectrum, many of the debug output sections can be customized to be shown/hidden as needed.