Function check_yaml_scan

tests/formattedcode/test_output_yaml.py:80–122

Check the scan `result_file` YAML results against the `expected_file` expected YAML results. If `regen` is True the expected_file WILL BE overwritten with the new scan results from `results_file`. This is convenient for updating tests expectations. But use with caution.

(
    expected_file,
    result_file,
    regen=REGEN_TEST_FIXTURES,
    remove_file_date=True,
    check_headers=False,
    remove_uuid=True,
)

def check_yaml_scan(
    expected_file,
    result_file,
    regen=REGEN_TEST_FIXTURES,
    remove_file_date=True,
    check_headers=False,
    remove_uuid=True,
):
    """
    Check the scan `result_file` YAML results against the `expected_file`
    expected YAML results.

    If `regen` is True the expected_file WILL BE overwritten with the new scan
    results from `results_file`. This is convenient for updating tests
    expectations. But use with caution.
    """
    results = load_yaml_results(
        location=result_file,
        remove_file_date=remove_file_date,
    ) or {}
    if remove_uuid:
        results = remove_uuid_from_scan(results)

    if regen:
        with open(expected_file, 'w') as reg:
            reg.write(saneyaml.dump(results))

    expected = load_yaml_results(
        location=expected_file,
        remove_file_date=remove_file_date,
    )
    if remove_uuid:
        expected = remove_uuid_from_scan(expected)

    if not check_headers:
        results.pop('headers', None)
        expected.pop('headers', None)

    # NOTE we redump the YAML as a string for a more efficient display of the
    # failures comparison/diff
    expected = saneyaml.dump(expected)
    results = saneyaml.dump(results)
    assert results == expected


def load_yaml_results(location, remove_file_date=True):