check_consistency

Summary

check_consistency(bundle: Bundle, skip: bool, skip_warnings: bool = False) → CheckResult

Checks to ensure that values that are stored in both the Fortune Avenue-compatible .frb board file, and in the Map Descriptor .yaml file, are the same.

Parameters:

• bundle (Bundle) – A Bundle object representing a board.

• skip (bool) – If set to True, the check will be skipped, but a valid resultobject with no messages and SKIPPED as its status will still be returned.

• skip_warnings (bool, optional) – If set, skips tests resulting in “Warning” messages.

Returns:

A CheckResult object containing the check status as well as any messages and additional data.

Return type:

CheckResult

Importing

from cs_board_tools.validation.consistency import check_consistency